{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Subscription Items API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Subscription Items", "type": "folder" }, "items": [ { "info": { "name": "GetSubscriptionItems", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/subscription_items", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "subscription", "value": "", "type": "query", "description": "The ID of the subscription whose items will be retrieved." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of your subscription items for a given subscription.

" }, { "info": { "name": "PostSubscriptionItems", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/subscription_items", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Adds a new item to an existing subscription. No existing items will be changed or replaced.

" }, { "info": { "name": "GetSubscriptionItemsItem", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/subscription_items/:item", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "item", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the subscription item with the given ID.

" }, { "info": { "name": "PostSubscriptionItemsItem", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/subscription_items/:item", "params": [ { "name": "item", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates the plan or quantity of an item on a current subscription.

" }, { "info": { "name": "DeleteSubscriptionItemsItem", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/subscription_items/:item", "params": [ { "name": "item", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

" }, { "info": { "name": "GetSubscriptionItemsSubscriptionItemUsageRecordSummaries", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/subscription_items/:subscription_item/usage_record_summaries", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "subscription_item", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

\n\n

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary informati" }, { "info": { "name": "PostSubscriptionItemsSubscriptionItemUsageRecords", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/subscription_items/:subscription_item/usage_records", "params": [ { "name": "subscription_item", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

\n\n

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

\n\n

The default calculation for usage is to add" } ] } ], "bundled": true }