Skip to main content
PUT
/
subscriptions
/
lineitems
/
{id}
Update subscription line item
curl --request PUT \
  --url https://api.cloud.flexprice.io/v1/subscriptions/lineitems/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "amount": 123,
  "billing_model": "FLAT_FEE",
  "effective_from": "<string>",
  "metadata": {},
  "tier_mode": "VOLUME",
  "tiers": [
    {
      "flat_amount": "<string>",
      "unit_amount": "<string>",
      "up_to": 123
    }
  ],
  "transform_quantity": {
    "divide_by": 123,
    "round": "<string>"
  }
}'
{
  "billing_period": "MONTHLY",
  "created_at": "<string>",
  "created_by": "<string>",
  "currency": "<string>",
  "customer_id": "<string>",
  "display_name": "<string>",
  "end_date": "<string>",
  "entity_id": "<string>",
  "entity_type": "plan",
  "environment_id": "<string>",
  "id": "<string>",
  "invoice_cadence": "ARREAR",
  "metadata": {},
  "meter_display_name": "<string>",
  "meter_id": "<string>",
  "plan_display_name": "<string>",
  "price": {
    "addon": {
      "created_at": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "entitlements": [
        {
          "addon": {},
          "created_at": "<string>",
          "created_by": "<string>",
          "display_order": 123,
          "entity_id": "<string>",
          "entity_type": "PLAN",
          "environment_id": "<string>",
          "feature": {
            "alert_settings": {
              "alert_enabled": true,
              "critical": {
                "condition": "above",
                "threshold": 123
              },
              "info": {
                "condition": "above",
                "threshold": 123
              },
              "warning": {
                "condition": "above",
                "threshold": 123
              }
            },
            "created_at": "<string>",
            "created_by": "<string>",
            "description": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "meter": {
              "aggregation": {
                "bucket_size": "MINUTE",
                "field": "<string>",
                "multiplier": 123,
                "type": "COUNT"
              },
              "created_at": "2024-03-20T15:04:05Z",
              "event_name": "api_request",
              "filters": [
                {
                  "key": "<string>",
                  "values": [
                    "<string>"
                  ]
                }
              ],
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "API Usage Meter",
              "reset_usage": "BILLING_PERIOD",
              "status": "published",
              "tenant_id": "tenant123",
              "updated_at": "2024-03-20T15:04:05Z"
            },
            "meter_id": "<string>",
            "name": "<string>",
            "status": "published",
            "tenant_id": "<string>",
            "type": "metered",
            "unit_plural": "<string>",
            "unit_singular": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          },
          "feature_id": "<string>",
          "feature_type": "metered",
          "id": "<string>",
          "is_enabled": true,
          "is_soft_limit": true,
          "parent_entitlement_id": "<string>",
          "plan": {
            "created_at": "<string>",
            "created_by": "<string>",
            "credit_grants": [
              {
                "cadence": "ONETIME",
                "created_at": "<string>",
                "created_by": "<string>",
                "credits": 123,
                "environment_id": "<string>",
                "expiration_duration": 123,
                "expiration_duration_unit": "DAY",
                "expiration_type": "NEVER",
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "period": "DAILY",
                "period_count": 123,
                "plan_id": "<string>",
                "priority": 123,
                "scope": "PLAN",
                "status": "published",
                "subscription_id": "<string>",
                "tenant_id": "<string>",
                "updated_at": "<string>",
                "updated_by": "<string>"
              }
            ],
            "description": "<string>",
            "display_order": 123,
            "entitlements": [
              {}
            ],
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "prices": [
              {}
            ],
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          },
          "plan_id": "<string>",
          "static_value": "<string>",
          "status": "published",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>",
          "usage_limit": 123,
          "usage_reset_period": "MONTHLY"
        }
      ],
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "prices": [
        {}
      ],
      "status": "published",
      "tenant_id": "<string>",
      "type": "onetime",
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "amount": 123,
    "billing_cadence": "RECURRING",
    "billing_model": "FLAT_FEE",
    "billing_period": "MONTHLY",
    "billing_period_count": 123,
    "conversion_rate": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "currency": "<string>",
    "description": "<string>",
    "display_amount": "<string>",
    "display_price_unit_amount": "<string>",
    "end_date": "<string>",
    "entity_id": "<string>",
    "entity_type": "PLAN",
    "environment_id": "<string>",
    "group": {
      "created_at": "<string>",
      "entity_ids": [
        "<string>"
      ],
      "entity_type": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "status": "<string>",
      "updated_at": "<string>"
    },
    "group_id": "<string>",
    "id": "<string>",
    "invoice_cadence": "ARREAR",
    "lookup_key": "<string>",
    "metadata": {},
    "meter": {
      "aggregation": {
        "bucket_size": "MINUTE",
        "field": "<string>",
        "multiplier": 123,
        "type": "COUNT"
      },
      "created_at": "2024-03-20T15:04:05Z",
      "event_name": "api_request",
      "filters": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "API Usage Meter",
      "reset_usage": "BILLING_PERIOD",
      "status": "published",
      "tenant_id": "tenant123",
      "updated_at": "2024-03-20T15:04:05Z"
    },
    "meter_id": "<string>",
    "parent_price_id": "<string>",
    "plan": {
      "created_at": "<string>",
      "created_by": "<string>",
      "credit_grants": [
        {
          "cadence": "ONETIME",
          "created_at": "<string>",
          "created_by": "<string>",
          "credits": 123,
          "environment_id": "<string>",
          "expiration_duration": 123,
          "expiration_duration_unit": "DAY",
          "expiration_type": "NEVER",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period": "DAILY",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "scope": "PLAN",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "description": "<string>",
      "display_order": 123,
      "entitlements": [
        {}
      ],
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "prices": [
        {}
      ],
      "status": "published",
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "plan_id": "<string>",
    "price_unit": "<string>",
    "price_unit_amount": 123,
    "price_unit_id": "<string>",
    "price_unit_tiers": [
      {
        "flat_amount": 123,
        "unit_amount": 123,
        "up_to": 123
      }
    ],
    "price_unit_type": "FIAT",
    "pricing_unit": {
      "base_currency": "<string>",
      "code": "<string>",
      "conversion_rate": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "precision": 123,
      "status": "published",
      "symbol": "<string>",
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "start_date": "<string>",
    "status": "published",
    "tenant_id": "<string>",
    "tier_mode": "VOLUME",
    "tiers": [
      {
        "flat_amount": 123,
        "unit_amount": 123,
        "up_to": 123
      }
    ],
    "transform_quantity": {
      "divide_by": 123,
      "round": "<string>"
    },
    "trial_period": 123,
    "type": "USAGE",
    "updated_at": "<string>",
    "updated_by": "<string>"
  },
  "price_id": "<string>",
  "price_type": "USAGE",
  "price_unit": "<string>",
  "price_unit_id": "<string>",
  "quantity": 123,
  "start_date": "<string>",
  "status": "published",
  "subscription_id": "<string>",
  "subscription_phase_id": "<string>",
  "tenant_id": "<string>",
  "trial_period": 123,
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Line Item ID

Body

application/json

Update Line Item Request

​
amount
number

Amount is the new price amount that overrides the original price

​
billing_model
enum<string>
Available options:
FLAT_FEE,
PACKAGE,
TIERED
​
effective_from
string

EffectiveFrom for the existing line item (if not provided, defaults to now)

​
metadata
object

Metadata for the new line item

​
tier_mode
enum<string>
Available options:
VOLUME,
SLAB
​
tiers
object[]

Tiers determines the pricing tiers for this line item

​
transform_quantity
object

Response

OK

​
billing_period
enum<string>
Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY,
QUARTERLY,
HALF_YEARLY
​
created_at
string
​
created_by
string
​
currency
string
​
customer_id
string
​
display_name
string
​
end_date
string
​
entity_id
string
​
entity_type
enum<string>
Available options:
plan,
addon
​
environment_id
string
​
id
string
​
invoice_cadence
enum<string>
Available options:
ARREAR,
ADVANCE
​
metadata
object
​
meter_display_name
string
​
meter_id
string
​
plan_display_name
string
​
price
object
​
price_id
string
​
price_type
enum<string>
Available options:
USAGE,
FIXED
​
price_unit
string
​
price_unit_id
string
​
quantity
number
​
start_date
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
subscription_id
string
​
subscription_phase_id
string
​
tenant_id
string
​
trial_period
integer
​
updated_at
string
​
updated_by
string