Returns a list of your subscription items for a given subscription.
Parameters
- subscriptionstringRequired
The ID of the subscription whose items will be retrieved.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with adata property that contains an array of up tolimit subscription items, starting after subscription itemstarting_. Each entry in the array is a separate subscription item object. If no more subscription items are available, the resulting array will be empty.
{"object":"list","url":"/v1/subscription_items","has_more":false,"data":[{"id":"si_OCgWsGlqpbN4EP","object":"subscription_item","created":1688507587,"metadata":{},"price":{"id":"price_1NQH9iLkdIwHu7ix3tkaSxhj","object":"price","active":true,"billing_scheme":"per_unit","created":1688507586,"currency":"usd","custom_unit_amount":null,"livemode":false,"lookup_key":null,"metadata":{},"nickname":null,"product":"prod_OCgWE6cbwiSu27","recurring":{"interval":"month","interval_count":1,"trial_period_days":null,"usage_type":"licensed"},"tax_behavior":"unspecified","tiers_mode":null,"transform_quantity":null,"type":"recurring","unit_amount":1000,"unit_amount_decimal":"1000"},"quantity":1,"subscription":"sub_1NQH9iLkdIwHu7ixxhHui9yi","tax_rates":[]}]}Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
Parameters
- proration_
behaviorenum Determines how to handleprorations when the billing cycle changes (e.g., when switching plans, resetting
billing_, or starting a trial), or if an item’scycle_ anchor=now quantitychanges. The default value iscreate_.prorations Possible enum valuesalways_invoice Always invoice immediately for prorations.
create_prorations Will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately undercertain conditions.
noneDisable creating prorations in this request.
More parameters
- clear_
usageboolean - proration_
datetimestamp
Returns
An subscription item object with a deleted flag upon success. Otherwise, this call raisesan error, such as if the subscription item has already been deleted.