Sample - Stripe API
GET/v1/subscription_items/{item}

Retrieve a subscription item

Retrieves a subscription item by its unique identifier. Use expand to include additional fields such as discounts, the associated price, or tax rates in the response. The response contains the item's billing period, quantity, subscription, price, metadata, discounts, and tax rates.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
itemstringrequired
The unique identifier of the subscription item to retrieve, limited to 5,000 characters.
expandarray<string>optional
Fields to expand in the response; each value may contain at most 5,000 characters.

2 status codes
200Returns the subscription item, including its identifier, subscription, price, quantity, billing periods, discounts, metadata, and tax rates.
billed_untilintegeroptional
The time period the subscription item has been billed for.
billing_thresholdsobjectoptional
Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
current_period_endintegerrequired
The end time of this subscription item's current billing period.
current_period_startintegerrequired
The start time of this subscription item's current billing period.
discountsarray<string>required
The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
idstringrequired
Unique identifier for the object.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:subscription_item
priceobjectrequired
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
quantityintegeroptional
The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
subscriptionstringrequired
The `subscription` this `subscription_item` belongs to.
tax_ratesarray<TaxRate>optional
The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
defaultReturns an error object containing details about the failed subscription item retrieval request.
errorobjectrequired

Error handling

item must identify the subscription item to retrieve and may contain at most 5,000 characters. expand values may contain at most 5,000 characters each.