Whether promotion codes can be applied to the checkout session.

The subtotal amount of the checkout session.

The total amount of the checkout session.

If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.

The ID of the customer for this Session. This object is expandable if expand_customer is set.

The customer values to prefill the customer details in the checkout page.

The time at which the Checkout Session will expire.

Whether the Checkout Session is HSA/FSA eligible.

The ID of the invoice this Checkout Session is for. This object is expandable if expand_invoice is set.

Whether a letter of medical necessity is required for this Checkout Session.

The URL to redirect to access the checkoout session.

The ID of the SetupIntent for this Checkout Session. This object is expandable if expand_setup_intent is set.

When set, present options for shipping address collection from a customer.

Shipping information for this Checkout Session.

The shipping rate options applied to this Session.

If this checkout session contains both items that are eligible for HSA/FSA and items that are not, This will be the ID of the split cart object. This object is expandable if expand_split_cart is set.

The ID of the subscription this Checkout Session is for. This object is expandable if expand_subscription is set.

The URL the customer will be directed to after the payment or subscription creation is successful.

Whether the Checkout Session is in test mode.

Tax and discount details for the computed total amount.

The type of visit this Checkout Session is for.

Origin of where the checkout session was generated

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions and checkout sessions.

Amount that will be taken off the subtotal of any invoices for this customer.

An object containing the ID of the product that the coupon can be applied to.

One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.

If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.

Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

Name of the coupon displayed to customers.

Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

Number of times this coupon has been applied to a customer.

Taking account of the above properties, whether this coupon can still be applied to a customer.

Applies to the first charge from a subscription with this coupon applied.

Applies to charges in the first duration_in_months months from a subscription with this coupon applied.

Applies to all charges from a subscription with this coupon applied.

A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).

An object containing directions for what this Coupon will apply discounts to.

Specifies how long the discount will be in effect if used on a subscription. Defaults to once.

Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid.

A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).

The product's description, a short blurb meant to be displayed to the customer.

The product's GTIN. If provided, this will be used to check whether the product is on the eligible product list.

The product's HSA/FSA eligibility that you are requesting.

The product's name, meant to be displayed to the customer.

If the product is HSA/FSA eligible through private lable, this should be provided.

The product's UPC code. If provided, this will be used to check whether the product is on the eligible product list.

A URL of a publicly-accessible image of the product.

If the product is eligible via LOMN, the visit type that was provided from the Flex team should be provided.

The customer-facing code. Regardless of case, this code must be unique across all active

The customer that can be associated with the promo code. If null, the promo code can be redeemed by any customer.

The number of times the promo code can be redeemed.

Export defines the export_type and filters needed to export a file Export types are supported for Payments, Subscriptions, Customers, CheckoutSession

The date the export functionality was completed.

The date the export functionality was started.

HttpError

The id of the latest charge for this invoice, if any.

Either charge_automatically or send_invoice. When charging automatically, Flex will attempt to pay this invoice using the default payment method attached to the customer. When sending an invoice, Flex will email this invoice to the customer with payment instructions.

The id of the customer this invoice is for.

The payment intent associated with this invoice. The payment intent is created when the invoice is finalized.

The subscription that this invoice was prepared for.

Whether or not the invoice was created in test mode.

The total amount of the invoice in cents.

Specifies whether the promo code is currently active.

Allows the session to be completed using a promotion code.

A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.

The ID of the Price object. One of price or price_data is required.

Data used to generate a new Price object inline. One of price or price_data is required.

The quantity of the line item being purchased.

The ID of the product that this price will belong to.

The recurring components of a price such as interval and trial period days.

A positive integer in cents (or 0 for a free price) representing how much to charge.

Indicates the parameters to be passed to PaymentIntent creation during checkout

Prices define the unit cost and (optional) billing cycle for both recurring and one-time purchases of products. Prices belong to a given product. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices.

the product this price belongs to. Note that this is not an expandable field.

The number of days the customer has to pay the invoice generated by this price after the subscription becomes due.

The type of the price. The type can be one of: `one-time` (a one-time price for a product) or `recurring` (a recurring price for a product).    /// The shopify product variant id that this price is associated with.

The unit amount in cents to be charged, represented as a whole integer.

A Product defines what you sell. Flex creates the The product can either be not eligible, elegible via auto-substantiation or elegible via letter of medical necessity.

Determines if the product is active or not.

The elegibility of the product for HSA/FSA.

The visit type of the product if a letter of medical necessity is required.

A promo code represents a code for a coupon that can be redeemed by a customer.

Whether the promo code is currently active.

The coupon that the promo code represents.

Coupon

The date and time the promo code was created.

The number of times the promo code has been redeemed.

The number of trial period days before the customer is charged for the first time.

A checkout session consists of 3 states. Open - The session has been created but not paid for. Paid - Deprecated. Complete - The LOMN was submitted (if applicable) and payment was successful.

If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

Time at which the object was created. ISO 8601 format.

End of the current period that the subscription has been invoiced for.

Start of the current period that the subscription has been invoiced for.

The ID of the customer who owns the subscription.

The ID of the latest invoice generated for this subscription.

Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.

This is the sum of all the discount amounts.

This is the sum of all the iias line items.

This is the sum of all the shipping amounts.

Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.

The location as a [`Vec`] of [`String`]s -- often in the form `["body", "field_name"]`, `["query", "field_name"]`, etc. They may, however, be arbitarily deep.

The message accompanying the validation error item.

The type of error, often "type_error" or "value_error", but sometimes with more context like as "value_error.number.not_ge"

Flex API

limit

offset

interval

payment_intent

subscription

client_reference_id

expand_customer

Returns a list of line items corresponding to a checkout session.

starting_after

ending_before

Returns a list of Issuing Dispute objects.

Returns a list of exports for the authenticated partner.

Retrieves the export details with the given ID.

customer

Retrieves the details of a PaymentIntent that has previously been created.

active

product

expand_product

Creates a new price for an existing product. The price can be recurring or one-time.

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Returns a product object for the product with the specified ID.

Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Returns a list of all refunds you’ve previously created.

status

Creates a new refund object and refund the specified payment.

Retrieves the details of an existing refund.

Returns the shipping rate object with the given ID.

Updates the specified shipping rate by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

Subscriptions by default are created with the status of `incomplete`. After the first payment is made, the status will change to `active` or `trialing`
in the case where a subscription has a trial period.

Cancels a customer’s subscription at the end of the current period. The customer will not be charged again for the subscription.

Retrieves the subscription with the given ID.

Refunds

Flex API Reference

List Refunds

Parameters

Create Refund

Parameters

Get Refund

Parameters