v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Retrieve prices based on optional filters

get/price

Query parameters

price_idstring

Filter by a specific price ID

plan_idsstring

Filter by comma-separated plan IDs

payment_systemstring

Filter by payment system (e.g., stripe, paddle, paypal, primer)

external_codestring

Filter by external code

external_idstring

Filter by external ID from payment system

Response

Prices retrieved successfully

idinteger

plan_idinteger

external_idstring

external_codestring

currencystring

amountstring

raw_datastring

created_atstring date-time

updated_atstring date-time

periodstring

period_intervalinteger

trial_period_pricestring

discount_duration_in_billing_periodsstring

trial_free_period_length_in_daysstring

amount_realnumber

discount_percentnumber

amount_real_with_discountnumber

price_option_textstring

Example response

[
  {
    "id": 549,
    "plan_id": 109,
    "external_id": "price_1PqGPoJvddo5s7fCb5uPh2re",
    "external_code": "group1_1month",
    "currency": "usd",
    "amount": "1499",
    "raw_data": "JSON",
    "created_at": "2024-09-27T15:36:09.000000Z",
    "updated_at": "2024-09-27T15:36:31.000000Z",
    "period": "month",
    "period_interval": 1,
    "trial_period_price": "0",
    "discount_duration_in_billing_periods": "0",
    "trial_free_period_length_in_days": "0",
    "phases": {
      "data": [
        {
          "value": 7,
          "price": 699
        }
      ]
    },
    "amount_real": 14.99,
    "amount_real_with_discount": 14.99,
    "price_option_text": "6.99 usd / 7 days → 14.99 usd / 1 month",
    "plan": {
      "id": 109,
      "project_id": 63,
      "payment_system": "stripe",
      "external_id": "prod_PsKBa7ceF91lMm",
      "name": "Kegel Subscription"
    }
  }
]