Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Prices

List Prices

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.

get/v1/prices

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

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

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

activeboolean nullable

Only return prices where active matches this value.

Only return prices where active matches this value.

productstring nullable

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

Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

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

expand_productboolean nullable

If true, expands the product object in the response.

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

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.

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

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.

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",
      "unit_amount": 0,
      "active": false,
      "created_at": "2026-06-15T14:30:00Z",
      "type": "one_time",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "test_mode": false
    }
  ]
}