Get a subscription item
Authorizations
Value for the Authorization header parameter.
Path Parameters
SubscriptionItem identifier
Response
The parent item of the item. If this is null, the item is a root item.
The plan this item is based on.
Usage values during the subscription item period.
The billing details of the item.
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
Further information defines additional information for the item which will be displayed in the invoice.
The price plan of the item, which defines the price and billing interval.
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.
active
, canceled
, pending
, terminated
The product of the item.
The date the subscription item was activated.
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.
addon
, charge
, plan-product
, product
The current measurement value of the item.
Is the period inherited from the subscription?
Was this page helpful?