List Prices

Lists the host's prices, optionally filtered by product, type, or active status. Sorted by creation date descending. Paginated.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

pageinteger

Page number (0-based, default 0)

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Items per page (default 20, max 100)

Default: 20Minimum: 1Maximum: 100

productIdstring

Filter by parent product

typestring

Filter by cadence; omit to include all

Value in: "recurring" | "one_time"

activeboolean

When set, returns only active or only archived prices

fieldsstring

Comma-separated list of fields to return. Valid: id, hostId, productId, type, currency, unitAmount, nickname, active, createdAt, updatedAt. Omit for all fields.

GET/v1/prices/

curl -X GET "https://api.3common.com/v1/prices/?productId=string&type=recurring&fields=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "id": "string",
      "hostId": "string",
      "productId": "string",
      "type": "recurring",
      "currency": "USD",
      "unitAmount": 9007199254740991,
      "recurring": {
        "interval": "day",
        "intervalCount": 1
      },
      "features": [
        {
          "featureKey": "string",
          "type": "boolean",
          "enabled": true
        }
      ],
      "nickname": "string",
      "active": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true
}

TypeScript

export interface Response {
  data: {
    id?: string;
    hostId?: string;
    /**
     * The Product this Price applies to
     */
    productId?: string;
    /**
     * Price cadence.
     * - recurring: billed on a fixed cadence (subscription-backed)
     * - one_time: single charge, typically used for add-on / top-up packs
     */
    type?: "recurring" | "one_time";
    currency?: "USD" | "CAD";
    /**
     * Per-unit cost in minor units (cents for USD)
     */
    unitAmount?: number;
    recurring?: {
      /**
       * Cadence unit
       */
      interval: "day" | "week" | "month" | "year";
      /**
       * Positive integer multiplier on interval (e.g. 3 with month = "every three months")
       */
      intervalCount: number;
    };
    features?: (
      | {
          featureKey: string;
          type: "boolean";
          enabled: boolean;
        }
      | {
          featureKey: string;
          type: "quantity";
          /**
           * null = unlimited
           */
          quantity: number | null;
          rolloverEnabled: boolean;
          rolloverCap?: number;
          expireOnCancel?: boolean;
        }
      | {
          featureKey: string;
          type: "enum";
          enumValue: string;
        }
      | {
          featureKey: string;
          type: "duration";
          /**
           * null = unlimited / "all time"
           */
          durationDays: number | null;
        }
    )[];
    /**
     * Admin-facing display label
     */
    nickname?: string;
    /**
     * Soft-archive flag. Inactive prices cannot back new subscriptions
     */
    active?: boolean;
    /**
     * Free-form key/value tags for integrations
     */
    metadata?: {
      [k: string]: string;
    };
    createdAt?: string;
    updatedAt?: string;
  }[];
  hasMore: boolean;
}