Skip to main content
PATCH
/
price_variants
/
{id}
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.priceVariants.update({
    id: "<id>",
    priceVariantUpdateRequest: {},
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "amount": 123,
  "amount_type": "free",
  "billing_type": "subscription",
  "recurring_interval": "day",
  "interval_count": 123,
  "installment_count": 123,
  "setup_fee_amount": 123,
  "trial_period_days": 123,
  "revoke_after_days": 123,
  "quantity_available": 123,
  "archived": true,
  "position": 123,
  "hidden": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "discounted_from_amount": 123,
  "minimum_amount": 123,
  "maximum_amount": 123,
  "preset_amount": 123,
  "waitlist": true,
  "purchase_url": "<string>",
  "product": "<string>",
  "benefits": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

​
id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Body

application/json
​
name
string
​
amount_type
enum<string>
Available options:
free,
fixed,
custom
​
amount
integer | null
​
currency
string | null
​
billing_type
enum<string>
Available options:
subscription,
one_time,
payment_plan
​
recurring_interval
enum<string> | null
Available options:
day,
week,
month,
year
​
interval_count
integer
​
installment_count
integer | null
​
setup_fee_amount
integer | null
​
trial_period_days
integer | null
​
revoke_after_days
integer | null
​
quantity_available
integer | null
​
waitlist
boolean
​
archived
boolean | null
​
hidden
boolean | null

Response

Price variant updated

​
id
string
required
​
object
string
required
​
name
string
required
​
amount
integer | null
required
​
amount_type
enum<string>
required
Available options:
free,
fixed,
custom
​
billing_type
enum<string>
required
Available options:
subscription,
one_time,
payment_plan
​
recurring_interval
enum<string> | null
required
Available options:
day,
week,
month,
year,
null
​
interval_count
integer
required
​
installment_count
integer | null
required
​
setup_fee_amount
integer | null
required
​
trial_period_days
integer | null
required
​
revoke_after_days
integer | null
required
​
quantity_available
integer | null
required
​
archived
boolean | null
required
​
position
integer
required
​
hidden
boolean | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
currency
string | null
required
​
discounted_from_amount
integer | null
required
​
minimum_amount
integer | null
required
​
maximum_amount
integer | null
required
​
preset_amount
integer | null
required
​
waitlist
boolean
required
​
purchase_url
string
required
​
product
string
required
​
benefits
string[]