WIwithflex
Prices

List Prices

Changed on

Returns a list of your prices, sorted by price ID in descending order (most recently created first). By default only active prices are returned; pass active=false to list archived ones, or filter to a single product with product. A price is also omitted when its parent product is archived, even if the price itself is active. Resolve prices by lookup key with lookup_keys[]=standard_monthly&lookup_keys[]=pro_monthly — up to 10 per request, matching any of them. You can separately filter by metadata using metadata[key]=value query parameters, for example metadata[lookup_key]=premium-plan. The two are independent: lookup_keys matches the price's own lookup_key field, while metadata[lookup_key] matches a key-value pair you set yourself, and a price can carry a different value in each.

get/v1/prices

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/prices
  • Auth
    HTTP bearer

Query parameters

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10
offsetinteger nullable

Number of objects to skip before returning results.

Example:3
activeboolean nullable

Only return prices where active matches this value.

productstring nullable

Filter by product ID to return prices for a specific product.

Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA
expand_productboolean nullable

If true, expands the product object in the response.

starting_afterstring nullable

A cursor for use in pagination. starting_after is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, ending with fprice_xyz, your subsequent call can include starting_after=fprice_xyz to fetch the next page.

Example:fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA
ending_beforestring nullable

A cursor for use in pagination. ending_before is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, starting with fprice_abc, your subsequent call can include ending_before=fprice_abc to fetch the previous page.

Example:fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA
lookup_keysstring[]

Resolve prices by their lookup_key, up to 10 per request. A price matches if its key is any of the values given. Both bracket forms are accepted and equivalent: ?lookup_keys[]=a&lookup_keys[]=b and ?lookup_keys[0]=a&lookup_keys[1]=b. Commas are not separators, so a key containing one needs no escaping. Distinct from metadata[lookup_key], which filters a key-value pair you set yourself.

[
  "standard_monthly",
  "pro_monthly"
]
metadataobject

Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.

{
  "lookup_key": "premium-plan"
}

Response

An envelope wrapping a list of price objects.

Example response

{
  "prices": [
    {
      "price_id": "fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "description": "Premium SPF 50 mineral sunscreen",
      "trial_period_days": 0,
      "unit_amount": 0,
      "recurring": {
        "interval": "day",
        "interval_count": 0,
        "trial_period_days": 0
      },
      "active": false,
      "product": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "created_at": "2026-06-15T14:30:00Z",
      "type": "one_time",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "lookup_key": "standard_monthly",
      "hsa_fsa_eligibility": "not_eligible",
      "test_mode": false
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • warning

      for the query request parameter limit, the max was set to 2147483647.00

    • warning

      for the query request parameter offset, the max was set to 2147483647.00

    • warning

      for the query request parameter limit, the min was set to -2147483648.00

    • warning

      for the query request parameter offset, the min was set to -2147483648.00

    • warning

      added the new adaptiveShoesDependent enum value to the /////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the /////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the /////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the /////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the /////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the /////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the /////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the /////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the /////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the /////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the /////////// response property for the response status

    • warning

      added the new uvClothing enum value to the /////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the /////////// response property for the response status

    • info

      added the new optional query request parameter lookup_keys

    • info

      added the new optional query request parameter metadata

    • info

      added the optional property // to the response with the status