WIwithflex
Prices

Create Price

Changed on

Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.

post/v1/prices

Request

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

Request body

Example request

{
  "price": {
    "lookup_key": "standard_monthly",
    "transfer_lookup_key": true,
    "description": "Premium SPF 50 mineral sunscreen",
    "unit_amount": 2500,
    "recurring": {
      "interval": "day",
      "interval_count": 0,
      "trial_period_days": 0
    },
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "product": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "product_data": {
      "name": "Example",
      "description": "Premium SPF 50 mineral sunscreen",
      "upc_code": "example_value",
      "gtin": "example_value",
      "reference_gtin": "example_value",
      "url": "https://example.com",
      "client_reference_id": "example_value",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "image_urls": [
        "https://example.com/image.png"
      ],
      "categories": [
        "string"
      ],
      "components": [
        "string"
      ]
    }
  }
}

Response

An envelope wrapping a single price object.

Example response

{
  "price": {
    "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

      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 request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status