- API
New in the API: week of October 5, 2026#
241 additions across Subscriptions, Customer account, and 28 more areas. These are additions, so nothing you already use needs to change.
- Endpoint
Remove subscription line item
- Endpoint
List subscription delivery migrations
- Endpoint
Get subscription delivery migration
- Endpoint
List subscriptions that could not be moved
- Endpoint
Update subscription line item
- Endpoint
Move subscribers to another delivery method
- Endpoint
Preview subscription
- Endpoint
Create a subscription access link
- Endpoint
List the current buyer's fulfillment events
- Endpoint
Swap subscription variant
- Endpoint
Send a receipt for one of the current buyer's orders
- Endpoint
Preview subscription
- Endpoint
Renew subscription now
- Endpoint
Skip subscription cycle
- Query parameter
subscription_delivery_changedonGET /v1/me/ordersFilter by whether the subscriber changed delivery after this order was paid.
- Query parameter
delivery_method_idonGET /v1/me/subscriptionsFilter by the subscription's selected delivery method.
- Endpoint
Create a customer email verification
- Endpoint
Confirm a customer email verification
- Endpoint
Link guest purchases to a customer
- Endpoint
Look up an email preference link
- Endpoint
Unsubscribe an email preference link
- Endpoint
Archive subscription offer
- Endpoint
List subscription offers
- Endpoint
Get subscription offer
- Endpoint
Update subscription offer
- Endpoint
Create subscription offer
- Endpoint
Get order payment attempt
- Endpoint
Create discount preview
- Endpoint
Create an order access link
- Endpoint
Cancel order payment attempt
- Query parameter
subscription_delivery_changedonGET /v1/ordersFilter by whether the subscriber changed delivery after this order was paid.
- Request field
subscriptiononPATCH /v1/orders/{order_id}/line-items/{order_line_item_id}Selects an active subscription offer and reprices an unpaid line.
- Request field
order_idonPOST /v1/discount-previewsThe order to evaluate.
- Request field
percentonPOST /v1/invoicesTax rate in percentage points, from 0 to 100 with up to four decimal places: `6.5` is 6.5%.
- Endpoint
Archive a subscription plan
- Endpoint
Get subscription plan
- Endpoint
Update subscription plan
- Request field
billing_intervalonPATCH /v1/subscription-plans/{subscription_plan_id}New unit of the plan's default billing period.
- Request field
billing_interval_countonPATCH /v1/subscription-plans/{subscription_plan_id}New number of `billing_interval` units between charges on the plan's default pair, up to 365.
- Request field
billing_interval_optionsonPATCH /v1/subscription-plans/{subscription_plan_id}Omission leaves the choices unchanged.
- Request field
inventory_routing_sourceonPATCH /v1/subscription-plans/{subscription_plan_id}Replaces the plan's routing source.
- Request field
subscription_delivery_method_idsonPATCH /v1/subscription-plans/{subscription_plan_id}Omission leaves the delivery methods unchanged.
- Endpoint
Get inventory allocation policy
- Endpoint
Get inventory item
- Values
condition_changedlosstheft - Values
adjustmentcount_appliedreservation_commitment_releasedreservation_committedreservation_expiredreservation_held
- Endpoint
Get merchant
- Endpoint
Update merchant
- Request field
icononPATCH /v1/merchantA square image, at least 128 by 128 pixels, shown where the store needs a small mark: browser tabs and compact headers.
- Field
A square image, at least 128 by 128 pixels, shown where the store needs a small mark: browser tabs and compact headers.
- Endpoint
Create a gift card funding disposition
- Query parameter
created_afteronGET /v1/gift-card-loadsInclusive lower bound on created_at.
- Query parameter
created_beforeonGET /v1/gift-card-loadsExclusive upper bound on created_at.
- Query parameter
created_afteronGET /v1/gift-card-notificationsInclusive lower bound on created_at.
- Query parameter
created_beforeonGET /v1/gift-card-notificationsExclusive upper bound on created_at.
- Query parameter
created_afteronGET /v1/gift-card-redemptionsInclusive lower bound on created_at.
- Query parameter
created_beforeonGET /v1/gift-card-redemptionsExclusive upper bound on created_at.
- Query parameter
posted_afteronGET /v1/gift-card-transactionsInclusive lower bound on posted_at.
- Endpoint
List invoice activities
- Request field
reminders_pausedonPATCH /v1/invoices/{invoice_id}Pauses (true) or resumes (false) the automatic reminder cadence.
- Request field
reason_messageonPOST /v1/invoices/{invoice_id}/late-fees/{invoice_late_fee_id}/waiveYour note explaining this action.
- Field
Whether automatic reminders are paused.
- Field
Tax rate in percentage points, from 0 to 100 with up to four decimal places: `6.5` is 6.5%.
- Values
customernone
- Endpoint
List promotion codes
- Field
The promotion this code belongs to.
- Endpoint
Create a return access link
- Request field
subscription_termsonPATCH /v1/checkout-sessions/{checkout_session_id}Subscription plan sessions only.
- Request field
timezoneonPATCH /v1/checkout-sessions/{checkout_session_id}Checkout credentials only.
- Request field
page_originonPOST /v1/checkout-sessionsOrigin of the page where you render this headless checkout, such as https://shop.example.com.
- Request field
subscription_plan_idonPOST /v1/checkout-sessionsAn active plan.
- Request field
subscription_termsonPOST /v1/checkout-sessionsThe billing interval, line quantities, and gift recipient for a `subscription_plan` session.
- Request field
reason_messageonPOST /v1/checkout-sessions/{checkout_session_id}/closeYour note explaining why you are closing the checkout session.
- Field
Recipient name of the customer's default shipping address.
- Field
Where the buyer completes a gift card challenge for this checkout.
- Request field
default_tip_percentonPATCH /v1/settingsOmit to preserve the current value.
- Request field
tip_percent_optionsonPATCH /v1/settingsThree tip percents to offer, each from 1 through 100 with at most four decimal places.
- Field
Whether buyers may change the shipping address and delivery method of their physical subscriptions.
- Field
Replaced as a whole: send every field you want to keep.
- Field
Seconds to wait after the buyer last changed their email or phone before sending the reminder.
- Field
Path under `merchant_account_url` for the email preferences page, with no placeholder.
- Field
Path under `merchant_account_url` for an invoice page, containing `{resource_id}` once.
- Field
Whether Flint emails the buyer when a renewal waits on stock.
- Request field
reason_messageonPOST /v1/webhook-deliveries/{webhook_delivery_id}/resendYour note explaining this action.
- Field
The note supplied when this action was requested.
- Field
The note supplied when this action was requested.
- Values
subscription_delivery_migration.completedsubscription_payment_retry.createdsubscription_payment_retry.failedsubscription_payment_retry.succeededsubscription.cycle_skippedsubscription.delivery_action_required - Values
subscription_delivery_migration.completedsubscription_payment_retry.createdsubscription_payment_retry.failedsubscription_payment_retry.succeededsubscription.cycle_skippedsubscription.delivery_action_required - Values
subscription_delivery_migration.completedsubscription_payment_retry.createdsubscription_payment_retry.failedsubscription_payment_retry.succeededsubscription.cycle_skippedsubscription.delivery_action_required - Values
subscription_delivery_migration.completedsubscription_payment_retry.createdsubscription_payment_retry.failedsubscription_payment_retry.succeededsubscription.cycle_skippedsubscription.delivery_action_required - Values
subscription_delivery_migration.completedsubscription_payment_retry.createdsubscription_payment_retry.failedsubscription_payment_retry.succeededsubscription.cycle_skippedsubscription.delivery_action_required
- Request field
base_fee_currency_optionsonPOST /v1/delivery-methodsBase delivery fee by ISO currency code.
- Request field
maximum_fee_currency_optionsonPOST /v1/delivery-methodsMaximum delivery fee by ISO currency code.
- Request field
maximum_fee_currency_optionsonPOST /v1/delivery-methodsMaximum delivery fee by ISO currency code.
- Request field
maximum_fee_currency_optionsonPOST /v1/delivery-methodsMaximum delivery fee by ISO currency code.
- Request field
minimum_fee_currency_optionsonPOST /v1/delivery-methodsMinimum delivery fee by ISO currency code.
- Request field
minimum_fee_currency_optionsonPOST /v1/delivery-methodsMinimum delivery fee by ISO currency code.
- Request field
minimum_fee_currency_optionsonPOST /v1/delivery-methodsMinimum delivery fee by ISO currency code.
- Request field
per_item_handling_fee_currency_optionsonPOST /v1/delivery-methodsHandling fee per item by ISO currency code.
- Request field
courier_support_phoneonPATCH /v1/fulfillments/{fulfillment_id}Buyer-safe support number for the courier or merchant fleet.
- Request field
courier_support_phoneonPOST /v1/fulfillmentsBuyer-safe support number for the courier or merchant fleet.
- Request field
reason_messageonPOST /v1/packages/{package_id}/voidYour internal note explaining this action.
- Request field
reason_messageonPOST /v1/shipments/{shipment_id}/voidYour internal note explaining this action.
- Field
Buyer-safe support number for the courier or merchant fleet.
- Field
The note supplied when this action was requested.
- Values
address_issuecustomer_no_showcustomer_requestfraud_reviewinventory_issuelocation_unavailable
- Field
Selected recurring terms for this variant.
- Field
The delivery question this preview answers. - `pickup_locations`: Lists the checkout session's pickup locations and whether each can supply its items.
- Field
The delivery question this preview answers. - `delivery_options`: Evaluates delivery methods and prices for the supplied items and buyer location.
- Field
Tax rate in percentage points, from 0 to 100 with up to four decimal places: `6.5` is 6.5%.
- Values
pickup_location_dependency_failurepickup_location_geography_unavailablepickup_location_inactivepickup_location_inventory_unavailable
- Field
Browser initialization data required to mount embedded account-management components.
- Field
Signed Flint token to exchange at POST /v1/merchant-account-session-refreshes.
- Field
Expiry of launch_token in UTC.
- Field
Whether to collect future requirements.
- Values
currently_dueeventually_due
- Request field
subscription_plan_idonPOST /v1/payment-linksID of the subscription plan the link sells.
- Field
ID of the subscription plan the link sells.
- Field
True when the plan has a line that ships or is delivered, so each renewal adds a shipping or delivery charge chosen at checkout.
- Field
ID of the subscription plan the link sells.
- Field
The merchant's icon.
- Query parameter
dispute_statusonGET /v1/payment-intentsExact match on dispute_status.
- Query parameter
refund_statusonGET /v1/payment-intentsExact match on refund_status.
- Error code
The payment processor rejected the request.
- Error code
The payment has an open risk review and must be approved before it can be captured.
- Field
Expiry of onboarding_session_token.
- Values
completeneeds_external_actionneeds_inputwaiting_for_review
- Values
buyer_clearedbuyer_selectedcalculation_changedcalculation_expiredcheckout_replacedcheckout_terminal
- Value
bank_return_not_contestable
- Values
fridaymondaythursdaytuesdaywednesday
- Values
activepending_exchangerevoked
- Value
active
- Field
Where the buyer saved this payment method.
- Field
DeliveryCalculatedPricingStrategy.base_fee_currency_optionsBase delivery fee by ISO currency code.
- Field
DeliveryCalculatedPricingStrategy.maximum_fee_currency_optionsMaximum delivery fee by ISO currency code.
- Field
DeliveryCalculatedPricingStrategy.minimum_fee_currency_optionsMinimum delivery fee by ISO currency code.
- Field
DeliveryCalculatedPricingStrategy.per_item_handling_fee_currency_optionsHandling fee per item by ISO currency code.
- Field
DeliveryEligibilityExpression.customer_has_phoneMatches when whether the customer has a phone number equals `value`.
- Field
DeliveryEligibilityExpression.subscription_purchaseMatches when whether the purchase is a subscription purchase equals `value`.
- Field
DeliveryExternalPricingStrategy.maximum_fee_currency_optionsMaximum delivery fee by ISO currency code.
- Field
DeliveryExternalPricingStrategy.minimum_fee_currency_optionsMinimum delivery fee by ISO currency code.
- Error code
A required external service failed.
- Error code
The requested payment option is not available for this merchant, amount, or checkout.
- Error code
The resource changed and the request must be rebuilt from its current state.