Changes to the Flint API, SDKs, and docs

Get order payment attempt

Create discount preview

Create an order access link

Cancel order payment attempt

The order to evaluate.

number

Your note explaining why you are closing the order.

Your note explaining this action.

Retire subscription plan

Get subscription plan

Update subscription plan

string

An early termination fee requires a contract term.

The contract term is longer than 120 months.

The contract term is shorter than one month.

The subscription plan currency is missing.

Send a receipt for one of the current buyer's orders

Create a Return resolution checkout session for the current buyer

Exact match on dispute_status.

Exact match on refund_status.

Filter by Flint subscription plan ID.

add_line_itemscancel_order_paymentcancel_payment_intentcapture_order_paymentcapture_payment_intentclose_checkout_sessionand 19 more

accounts.api_keys.readaccounts.api_keys.writeaccounts.devices.readaccounts.devices.writeaccounts.organizations.readaccounts.organizations.writeand 87 more

adjustmentcharge_addedcharge_fulfillment_updatedcharge_removedcharge_updatedcheckout_session_createdand 21 more

Get merchant

Update merchant

A square image, at least 128 by 128 pixels, shown where the store needs a small mark: browser tabs and compact headers.

A square image, at least 128 by 128 pixels, shown where the store needs a small mark: browser tabs and compact headers.

The image's dimensions don't fit what this image is for: a merchant icon must be square and at least 128 by 128 pixels.

A merchant address field is too long, or the country is not a two-letter country code.

The organization_id is empty or identifies a deleted organization.

The support email address is not valid.

Get inventory allocation policy

Get inventory item

commitcondition_changedconsumedamagedamageddepartand 20 more

adjustmentcount_appliedfulfillment_consumedreservation_commitment_releasedreservation_committedreservation_expiredand 11 more

List promotion codes

The promotion this code belongs to.

A promotion rule is missing its attribute.

Service charge promotions do not use a calculation basis.

The promotion code is empty.

Codes can only be set on a promotion whose redemption_type is code.

A promotion whose redemption_type is code needs at least one code.

The promotion needs discounted_item_rules to identify what it discounts.

List invoice activities

Pauses (true) or resumes (false) the automatic reminder cadence.

Your note explaining this action.

Whether automatic reminders are paused.

The manual payment is larger than the invoice's collectible balance.

The payment intent has already succeeded and cannot be canceled.

The invoice has no customer default payment term to use.

A payment option and currency pair has more than one limit.

Create a gift card funding disposition

RFC3339 lower bound for created_at.

RFC3339 upper bound for created_at.

RFC3339 lower bound for created_at.

RFC3339 upper bound for created_at.

RFC3339 lower bound for created_at.

RFC3339 upper bound for created_at.

RFC3339 lower bound for posted_at.

Create a subscription access link

Filter by Flint subscription plan ID.

string

Early termination fee frozen in the subscription's contract terms.

string

string

The merchant has not finished live account setup with the payment processor.

This merchant environment has no supported payment processor account yet.

Create a return access link

Buyer-safe support number for the courier or merchant fleet.

Your note explaining this transition.

Your note explaining this transition.

Your note explaining this transition.

Your note explaining this transition.

Your note explaining this transition.

Your note explaining this transition.

Your note explaining this transition.

string

The preselected tip percent, from 1 through 100 with at most four decimal places.

Three tip percents to offer, each from 1 through 100 with at most four decimal places.

string

string

Image

An active payment link cannot add, remove, or change the key or catalog source of its line items.

A unit_price_overrides amount is above the line item's max_unit_price_money.

A charge in the request does not belong to the order or has no settled amount to refund.

The charge refund amount is more than the charge's remaining refundable amount.

The charges in the request add up to more than the refund amount_money.

The request names the same order charge more than once.

The request names the same order line item more than once.

The explicit tax_money equals the tax the line would refund automatically.

A charge refund amount_money is zero or negative.

A line item refund amount is zero or negative, or nothing remains after its refund adjustments.

Omit to preserve the current value.

Three tip percents to offer, each from 1 through 100 with at most four decimal places.

Seconds to wait after the buyer last changed their email or phone before sending the reminder.

The preselected tip percent, from 1 through 100 with at most four decimal places.

Three tip percents to offer, each from 1 through 100 with at most four decimal places.

The default line item tax category is not supported while automatic tax is connected.

Custom domains are not active for this account.

The custom domain is already assigned to another account.

Exact match on dispute_status.

Exact match on refund_status.

The ACH debit confirmation token is missing the billing name or billing email.

The ACH debit confirmation token does not include the buyer's online mandate acceptance.

The amount is below the minimum allowed for the payment option.

The amount exceeds the maximum allowed for the payment option.

The payment processor's amount for this payment intent no longer matches Flint's record.

amount_money cannot change once a payment source is attached or confirmation is attempted, or when an order owns the payment intent.

Another variant or bundle already uses this barcode.

A variant selects more than one value for the same option.

An active variant does not select one value for each active option.

default_variant_id does not identify an active variant on this product.

The inventory item is not active, so it cannot be assigned to a variant.

The inline inventory item name is missing or too long.

The variant sets both inventory_item_id and inventory_item.

The unit price has no currency.

The attribute is not available for this merchant's risk rules.

The risk rule description is blank or longer than 512 characters.

A list_alias in the predicate is not a lowercase identifier.

The request adds no risk list items or more than 500.

The name is missing, blank, or too long.

A comparison value does not fit its attribute or operator.

The promotion rule operator is not valid for its attribute.

The risk rule predicate is not valid JSON.

Base delivery fee by ISO currency code.

Maximum delivery fee by ISO currency code.

Maximum delivery fee by ISO currency code.

Maximum delivery fee by ISO currency code.

Minimum delivery fee by ISO currency code.

Minimum delivery fee by ISO currency code.

Minimum delivery fee by ISO currency code.

Handling fee per item by ISO currency code.

The parent organization is deleted or is the organization itself.

The user who created the API key has no direct membership in this organization.

The new parent organization is a descendant of this organization.

The organization still has active child organizations.

The organization is still linked to an active merchant.

Only the organization owner can transfer ownership.

The owner role cannot be granted through a membership change.

Your organization role cannot assign the requested role.

Your note explaining this action.

The note supplied when this action was requested.

The note supplied when this action was requested.

The event_source filter contains an unsupported source.

The event_sources filter contains an unsupported source.

The URL host does not resolve to a public IP address.

The webhook endpoint URL does not use HTTPS.

The update sets partner event sources, partner_app_id, or mode on a merchant webhook endpoint.

string

Your note explaining why you are closing the checkout session.

string

Flint subscription plan ID the terms come from.

string

The checkout customer does not match the order's customer.

The checkout names a customer, but the order has no customer.

The resource cannot move to the requested status from its current status.

The modifier defaults conflict with the group's selection limits.

The modifier group is used by a modifier set that is not archived.

The modifier group name is missing.

A referenced modifier group was archived before the modifier set was saved.

A modifier cannot be archived while its group is used by a modifier set that is not archived.

A modifier name is missing.

The referenced modifier group is defined inline by a modifier set and cannot be reused.

The modifier set is attached to a product, variant, or bundle.

A category name matches more than one category.

The bundle is used by an active payment link.

The bundle is used by an active subscription.

The bundle is used by an active subscription plan.

The bundle is used by an open checkout session.

The bundle is used by an open invoice payment attempt.

The bundle is used by an open order.

A category is invalid, or the request has more than 100 categories.

completeneeds_external_actionneeds_inputready_for_api_keywaiting_for_review

merchant_readyonboarding_availablereadyverification_required

The requested capabilities differ from the ones account setup already started with.

A requested capability needs another capability that the request does not include.

The country differs from the one account setup already started with.

A country is required to start live account setup.

requested_capabilities lists the same capability more than once.

requested_capabilities is an empty array.

The note supplied when this action was requested.

api_keyapi_request_logbalancebalance_transactionbundlebundle_componentand 99 more

balancebalance_transactionbundlecapabilitycategorycheckout_sessionand 42 more

api_requestimage_mutationwebhook_delivery_attemptwebhook_event

balance_transaction.createdbalance_transaction.updatedbalance.updatedcapability.updatedcheckout_session.closedcheckout_session.completedand 196 more

api_keyapi_request_logbalancebalance_transactionbundlebundle_componentand 99 more

deliveredfailedpendingqueuedsending

pluginserver

pluginserver

active

activeerroredflagged_for_reviewpending_consentpending_exchangepending_onboardingand 2 more

pluginserver

active

activepending_exchangerevoked

The delivery question this preview answers. - `pickup_locations`: Lists the checkout session's pickup locations and whether each can supply its items.

The delivery question this preview answers. - `delivery_options`: Evaluates delivery methods and prices for the supplied items and buyer location.

pickup_location_dependency_failurepickup_location_geography_unavailablepickup_location_inactivepickup_location_inventory_unavailable

pluginserver

authorization_coderefresh_token

bearer

customer_has_phone

checkout_context_requireddependency_failureeligibility_no_matchinput_requiredmethod_unavailablepreview_unsupported

fridaymondaysaturdaysundaythursdaytuesdayand 1 more

fridaymondaythursdaytuesdaywednesday

A credit note text field is empty or longer than 255 characters.

The tax identity is invalid.

buyer_clearedbuyer_selectedcalculation_changedcalculation_expiredcheckout_replacedcheckout_terminaland 11 more

The Location is not active in this environment.

bank_return_not_contestableprovider_response_unavailable

A checkout session can list only active payment methods.

The user's merchant role does not allow API key management.

The checkout session closed, so it cannot be used for this request.

The description is too long.

The payment processor could not complete a required customer or payment method operation.

A delivery method with caller_supplied pricing cannot be used by hosted checkout or a payment link.

A price or fee amount is zero or negative.

A URL in the request is malformed or does not use HTTPS where HTTPS is required.

The merchant environment for this request could not be resolved.

The order is closed or fully paid, so it cannot accept this action.

List gift card loads

Get a gift card load

List gift card notifications

Get a gift card notification

List gift card redemptions

Get a gift card redemption

List gift card transactions

List gift cards

Remove a saved gift card

List the current buyer's deletion requests

Get the current buyer's email preferences

List your saved gift cards

Get a saved gift card

List a saved gift card's balance history

Get one of the current buyer's payment methods

Get a payment retry for one of the current buyer's subscriptions

Remove a selected gift card

Apply a gift card to an order

Send an order receipt

Replaces the recipient of an unfunded gift card purchase.

Accept the exact gift_card_estimate returned on the current order, including all selected cards and both totals.

Accept the exact gift_card_estimate returned on the current order, including all selected cards and both totals.

A US or Canadian mobile phone number in E.164 format, such as +14155552671, that confirms a card saved while the checkout acts for no customer, or for the customer whose email the buyer confirmed in it.

A US or Canadian mobile phone number in E.164 format, such as +14155552671, that confirms a card saved while the checkout acts for no customer, or for the customer whose email the buyer confirmed in it.

How the code reaches the buyer.

Types of the delivery methods that can serve this group's items, each listed once, in the order the methods display.

How the code reached the buyer: email or sms.

Last two digits of the number a texted code went to, so the buyer knows which phone to check.

The card the buyer saved with this checkout's payment by giving a mobile phone number, and whether they confirmed it.

Whether the buyer can save the card they type by giving a US or Canadian mobile phone number with the payment, in save_payment_method_phone on POST /v1/orders/{order_id}/pay, and confirming it with a texted code after paying.

confirm_saved_payment_methodgift_card_purchase

auto

Replaces the complete gift card configuration.

Only valid for product_type gift_card.

Gift card issuance terms. face_value_money is the reference denomination; unit_price_money is its price.

gift_card

gift_card

gift_card

gift_card

The gift card face value, price mode, or custom amount bounds are invalid.

Original standalone gift card funding load paid by a Flint payment.

Exhaustive allocations to original tenders.

array of RefundTenderAllocation

Cash returned after an unissued gift card purchase refund failed.

amountquantity

catalog_modifiertext

The original gift card purchase value is unavailable for this cash refund.

The original gift card cannot accept the full refund within its lifecycle and balance cap.

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updatedand 5 more

What the buyer can do with the subscription, in this order: cancel, pause, resume, reactivate, update_payment_method, then retry_payment, under the store's customer_account.buyer_capabilities.

Who asked to cancel, when, and why.

A subscription was set to cancel at the end of its billing period.

A subscription's scheduled cancellation was undone, so it renews as usual.

This line item does not sell a gift card.

A gift card purchase requires a catalog variant.

Where this option's items leave from, one leg per origin Location.

Types of the delivery methods that can serve this group's items, each listed once, in the order the methods display.

Inputs this selection still needs before payment: each recipient field a chosen option requires that the selection does not include.

Inputs this selection still needs before payment: each recipient field a chosen option requires that the selection does not include.

The Location cannot supply this inventory demand.

The demand requires more Locations than the allocation policy allows.

The delivery selection is missing recipient details that the selected delivery requires.

The order has selected gift cards but the payment does not accept their allocation.

gift_card_liability_v1orders_itemized_v2

gift_card_liability_v1orders_itemized_v2

undetermined

undetermined

What the buyer can do with the return, in this order: withdraw, ship_items, then pay_balance.

undetermined

other

The requested merchant is unavailable to this developer identity.

The theme a checkout opened from this link uses: your checkout branding settings, with the link's own `theme` over them.

What buyers may do to their own subscriptions in Flint's buyer account or through a customer session, in either mode.

Gift card variants cannot be sold through subscriptions.

A gift card funding lot was recorded with face value and consideration provenance.

A gift card funding lot's remaining value or risk restriction changed.

A gift card recipient notification was created.

A gift card recipient notification's delivery status changed.

An exact gift card redemption was reserved or captured.

A gift card redemption was captured, released, expired or refunded.

An immutable gift card financial movement was posted.

Automatic tax needs an active tax connection for the account.

The store's cancellation reason list names a reason twice.

The store's cancellation reason list has more than 8 reasons.

Hosted checkout collects an order with one payment method, and the order has more than one unpaid payment leg.

A bundle cannot contain a gift card variant.

The gift card variant has incompatible tax, inventory, or currency settings.

Fresh identity verification is required for gift card recipient, secret replacement, or delegation access.

The buyer cancellation timing is not supported.

Send a checkout verification code

Confirm a checkout verification code

Checkout session credentials only.

Contact the buyer entered in checkout before paying, saved with the session's checkout credential.

Contact and default addresses of the customer the checkout acts for: the customer the merchant created the session for, or the customer whose email the buyer confirmed in it.

How the buyer can reach the merchant for help: the support email, phone, and URL the merchant set.

Whether checkout offers the buyer the option to save the card they type for faster checkout at this merchant.

Whether the buyer must confirm their email with a code before the checkout can save their card or use their saved cards.

payment_refund_not_attempted

payment_refund_not_attempted

The refund amount is more than what remains refundable on the order or payment.

A refund that names both line items and charges needs a top-level amount_money.

The line item refund amount is more than the line's remaining refundable amount.

The line item refund quantity is more than the line's remaining refundable quantity.

The line items in the request add up to more than the refund amount_money.

The order has no succeeded payments to refund.

The buyer's choice to save the card they typed for faster checkout at this merchant.

The buyer's choice to save the card they typed for faster checkout at this merchant.

attempt_failedauthentication_requiredauthorization_canceledbank_account_closedbank_account_not_foundbank_account_restrictedand 49 more

The order's customer is not the customer this checkout session was created for.

A checkout session payment was started without expected_outstanding_money.

The payment attempt already finished and cannot be canceled.

Saving a card requires one newly collected card sent as a confirmation_token.

This checkout does not offer saving the buyer's card.

manualplatformscheduled

The request payload or query parameters did not pass validation.

The request payload or query parameters did not pass validation.

Payout destinations cannot be managed for this merchant.

Payout settings cannot be managed for this merchant.

Payouts are not enabled for this merchant.

Standard payouts are not enabled for this merchant.

Required for a package on a return shipment: allocates quantities from the shipment's return_line_items to this parcel.

Return this package belongs to.

Return line quantities allocated to this parcel.

failedsent

Filter by usage: off_session payment methods can be charged without the buyer; on_session ones were saved by buyers for faster checkout.

string

A subscription that is not canceled still uses the payment method.

The payment source is unknown, not active, or could not be resolved.

The invoice has no collectible schedule entry, or the selected entry is not the next one due.

Filter by usage: off_session payment methods can be charged without the buyer; on_session ones were saved by buyers for faster checkout.

When Flint may charge the payment method. off_session payment methods can pay subscriptions, automatic invoices, and other charges without the buyer, and can be a customer's default. on_session payment methods were saved by the buyer in checkout for faster checkout at this merchant; Flint charges them only in checkouts the buyer completes and refuses them for any charge without the buyer and as a default.

Checkout reminder email: one email to a buyer who entered an email address in hosted checkout and left without paying.

Whether hosted checkout offers buyers the option to save the card they type for faster checkout at this merchant.

The request payload or query parameters did not pass validation.

An assigned delivery method, or a zone, location set, or rate callback it uses, is missing or not active.

The operation needs a capability that was not requested when the merchant account was created.

Checkout reminder emails need a business address on the merchant, which the reminder prints.

Saved payment details for checkout can only be configured for a merchant.

Instant payouts are not available.

The request payload or query parameters did not pass validation.

The email address is not valid.

The checkout reminder delay is outside the supported range.

The request payload or query parameters did not pass validation.