Skip to main content

Update plan​

Update a plan by ID.

Path Parameters
    id string required

    ID of the plan to update

Request Body required
    body object
    name string
    title string
    description string
    features object[]
  • Array [
    • id string
    name string
    title string
    description string
    planIds string[]
    state string
    prices object[]
  • Array [
    • id string
    featureId string
    providerId string
    name string
    interval known intervals are "day", "week", "month", and "year"
    usageType usage_type known types are "licensed" and "metered"
    billingScheme billing_scheme known schemes are "tiered" and "flat"
    state string
    currency currency like "usd", "eur", "gbp"
    amount int64
    meteredAggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
    tierMode tier_mode known modes are "graduated" and "volume"
    metadata object
    createdAt date-time

    The time when the price was created.

    updatedAt date-time

    The time when the price was updated.

  • ]
    • creditAmount int64
    metadata object
    createdAt date-time

    The time when the feature was created.

    updatedAt date-time

    The time when the feature was updated.

  • ]
    • interval known intervals are "day", "week", "month", and "year"
    metadata object
Responses

A successful response.

Schema
    plan object
    id string
    name string
    title string
    description string
    features object[]
  • Array [
    • id string
    name string
    title string
    description string
    planIds string[]
    state string
    prices object[]
  • Array [
    • id string
    featureId string
    providerId string
    name string
    interval known intervals are "day", "week", "month", and "year"
    usageType usage_type known types are "licensed" and "metered"
    billingScheme billing_scheme known schemes are "tiered" and "flat"
    state string
    currency currency like "usd", "eur", "gbp"
    amount int64
    meteredAggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
    tierMode tier_mode known modes are "graduated" and "volume"
    metadata object
    createdAt date-time

    The time when the price was created.

    updatedAt date-time

    The time when the price was updated.

  • ]
    • creditAmount int64
    metadata object
    createdAt date-time

    The time when the feature was created.

    updatedAt date-time

    The time when the feature was updated.

  • ]
    • interval known intervals are "day", "week", "month", and "year"
    metadata object
    createdAt date-time

    The time when the plan was created.

    updatedAt date-time

    The time when the plan was updated.

Loading...