PATCH
/
subscription-items
/
{id}

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

SubscriptionItem identifier

Body

name
string
required

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

Maximum length: 255
description
string | null
required

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

Maximum length: 5000
furtherInformation
string | null
required

Further information defines additional information for the item which will be displayed in the invoice.

Maximum length: 5000
periods
object[]

The contract period terms of the subscription item. If empty, it is always cancelable.

Response

200 - application/json
id
string
parent
object

The parent item of the item. If this is null, the item is a root item.

plan
object

The plan this item is based on.

measurementValues
object[]

Usage values during the subscription item period.

billing
object

The billing details of the item.

name
string

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

description
string | null

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

furtherInformation
string | null

Further information defines additional information for the item which will be displayed in the invoice.

pricePlan
object

The price plan of the item, which defines the price and billing interval.

status
enum<string>

The status of the item.

Possible values:

  • active: The item is active and will be billed.
  • canceled: The item is canceled and will be billed until the end of the contract.
  • pending: The item is pending and will be billed after the contract start.
  • terminated: The item is terminated and will not be billed.
Available options:
active,
canceled,
pending,
terminated
product
object

The product of the item.

appliedDiscounts
object[]
periods
object[]
activatedAt
string | null

The date the subscription item was activated.

type
enum<string>

The type of the item.

Possible values:

  • option: The item is an product set option.
  • charge: The item is a charge.
  • plan-product: The item is a plan product.
  • product: The item is a product, and not created from a plan.
Available options:
addon,
charge,
plan-product,
product
currentMeasurementValue
object

The current measurement value of the item.

inheritedPeriod
boolean

Is the period inherited from the subscription?

Was this page helpful?

Remove a subscription itemGet estimated amount