{ "info": { "_postman_id": "a007ff4f-b177-4235-93e3-69248ed0be5c", "name": "Stripe Subscription API", "description": "Needs description.\n\nContact Support:\n Name: Stripe Dev Platform Team\n Email: dev-platform@stripe.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T13:24:21.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-a007ff4f-b177-4235-93e3-69248ed0be5c" }, "item": [ { "name": "v1", "item": [ { "name": "subscription_items", "item": [ { "name": "{item}", "item": [ { "name": "Delete Subscription Items Item", "id": "04066331-e344-42c1-a1f8-4f9587a3d1a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", "key": "clear_usage", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "id": "89c7e467-5e9f-4358-b3ac-0fc7d6ea1afe", "key": "item", "value": "", "description": "(Required) " } ] }, "description": "

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

" }, "response": [ { "id": "87f5e97d-d600-47fd-8d17-4dd6a71ee485", "name": "Successful response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", "key": "clear_usage", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "key": "item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deleted\": true,\n \"id\": \"\",\n \"object\": \"subscription_item\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-87f5e97d-d600-47fd-8d17-4dd6a71ee485" }, { "id": "73cd8aad-ffae-4ab6-b328-53de780ce383", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", "key": "clear_usage", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "key": "item" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-73cd8aad-ffae-4ab6-b328-53de780ce383" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-04066331-e344-42c1-a1f8-4f9587a3d1a6" }, { "name": "Get Subscription Items Item", "id": "fafbd18a-3e6d-454c-a188-51109c63fb17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "id": "6837539a-abda-4b5a-a3f5-c7583b5a5198", "key": "item", "value": "", "description": "(Required) " } ] }, "description": "

Retrieves the subscription item with the given ID.

" }, "response": [ { "id": "049bb3ac-ab61-4b98-a11e-6c1a45c80dc1", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"Utb6e\": \"\",\n \"ipsumc36\": \"\",\n \"culpa0\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-049bb3ac-ab61-4b98-a11e-6c1a45c80dc1" }, { "id": "e134ea86-be7e-4fcd-ad8b-24ad0d9882a6", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "item" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-e134ea86-be7e-4fcd-ad8b-24ad0d9882a6" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-fafbd18a-3e6d-454c-a188-51109c63fb17" }, { "name": "Post Subscription Items Item", "id": "9cbbb01e-81bb-4287-aa5e-090fc1d3cf88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "key": "metadata[sit6]", "value": "" }, { "key": "metadata[aliqua__]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "month" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "inclusive" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "id": "ee7aed05-9996-448c-b7a2-3cf967f7e5b9", "key": "item", "value": "", "description": "(Required) " } ] }, "description": "

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

" }, "response": [ { "id": "4b62b838-95cd-4f32-b184-a238d51b60af", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "key": "metadata[sit6]", "value": "" }, { "key": "metadata[aliqua__]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "month" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "inclusive" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "key": "item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"Utb6e\": \"\",\n \"ipsumc36\": \"\",\n \"culpa0\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-4b62b838-95cd-4f32-b184-a238d51b60af" }, { "id": "9fb9e21c-ff51-4353-8989-b171ad762423", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "key": "metadata[sit6]", "value": "" }, { "key": "metadata[aliqua__]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "month" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "inclusive" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:item", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":item" ], "variable": [ { "key": "item" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9fb9e21c-ff51-4353-8989-b171ad762423" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9cbbb01e-81bb-4287-aa5e-090fc1d3cf88" } ], "id": "af8ea61b-ea3b-4530-8075-e842b94b74fd", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-af8ea61b-ea3b-4530-8075-e842b94b74fd" }, { "name": "{subscription_item}", "item": [ { "name": "usage_record_summaries", "item": [ { "name": "Get Subscription Items Subscription Item Usage Record Summaries", "id": "4a78af6f-99ac-4b48-a19e-fd1593a75edb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_record_summaries?ending_before=&expand=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_record_summaries" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" } ], "variable": [ { "id": "29eee65a-bdc2-4bc8-b956-37864aa4cc00", "key": "subscription_item", "value": "", "description": "(Required) " } ] }, "description": "

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that\u2019s 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\u2019t ended yet. Since new usage records can still be added, the returned summary information for the subscription item\u2019s ID should be seen as unstable until the subscription billing period ends.

" }, "response": [ { "id": "aa8752c4-9a09-4ea4-a4a6-cbdc06c3f9e7", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_record_summaries?ending_before=&expand=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_record_summaries" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "subscription_item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"reference #/components/schemas/usage_record_summary not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/usage_record_summary not found in the OpenAPI spec\"\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-aa8752c4-9a09-4ea4-a4a6-cbdc06c3f9e7" }, { "id": "42049b49-26fc-4921-9ada-e005e18339ae", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_record_summaries?ending_before=&expand=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_record_summaries" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "subscription_item" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-42049b49-26fc-4921-9ada-e005e18339ae" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-4a78af6f-99ac-4b48-a19e-fd1593a75edb" } ], "id": "c228b71b-42aa-478b-9b9b-a2774b5e3f3d", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-c228b71b-42aa-478b-9b9b-a2774b5e3f3d" }, { "name": "usage_records", "item": [ { "name": "Post Subscription Items Subscription Item Usage Records", "id": "30c44c68-71ee-420f-993a-f29c3f117c78", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The usage quantity for the specified timestamp.", "key": "quantity", "value": "" }, { "description": "Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.", "key": "action", "value": "increment" }, { "key": "expand", "value": "" }, { "key": "timestamp", "value": "now" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_records", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_records" ], "variable": [ { "id": "64fd6910-e9b1-4b60-bcec-7c9ba519a1c5", "key": "subscription_item", "value": "", "description": "(Required) " } ] }, "description": "

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 up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan\u2019s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

\n\n

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

" }, "response": [ { "id": "c544e462-6e8b-41f6-9554-0edc98ba3367", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The usage quantity for the specified timestamp.", "key": "quantity", "value": "" }, { "description": "Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.", "key": "action", "value": "increment" }, { "key": "expand", "value": "" }, { "key": "timestamp", "value": "now" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_records", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_records" ], "variable": [ { "key": "subscription_item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"usage_record\",\n \"quantity\": \"\",\n \"subscription_item\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-c544e462-6e8b-41f6-9554-0edc98ba3367" }, { "id": "f41dc7c3-7259-4791-a363-4f00530f02b4", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The usage quantity for the specified timestamp.", "key": "quantity", "value": "" }, { "description": "Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.", "key": "action", "value": "increment" }, { "key": "expand", "value": "" }, { "key": "timestamp", "value": "now" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items/:subscription_item/usage_records", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items", ":subscription_item", "usage_records" ], "variable": [ { "key": "subscription_item" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-f41dc7c3-7259-4791-a363-4f00530f02b4" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-30c44c68-71ee-420f-993a-f29c3f117c78" } ], "id": "beea746b-2f71-47cc-a4ce-d2e426014695", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-beea746b-2f71-47cc-a4ce-d2e426014695" } ], "id": "ae27659a-928d-4afc-9215-25f04cb7c864", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-ae27659a-928d-4afc-9215-25f04cb7c864" }, { "name": "Get Subscription Items", "id": "e8c12d04-e215-4b15-b236-64e96e8c77a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items?ending_before=&expand=&limit=&starting_after=&subscription=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "(Required) The ID of the subscription whose items will be retrieved.", "key": "subscription", "value": "" } ] }, "description": "

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

" }, "response": [ { "id": "9e2d0d05-dbb5-4afa-830f-e147b5908d70", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items?ending_before=&expand=&limit=&starting_after=&subscription=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "(Required) The ID of the subscription whose items will be retrieved.", "key": "subscription", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_d_\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"minim24\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"/v1/subscription_items\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9e2d0d05-dbb5-4afa-830f-e147b5908d70" }, { "id": "58992de5-4b8c-4e6f-932a-fb1f2f5e6a03", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items?ending_before=&expand=&limit=&starting_after=&subscription=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ], "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "(Required) The ID of the subscription whose items will be retrieved.", "key": "subscription", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-58992de5-4b8c-4e6f-932a-fb1f2f5e6a03" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-e8c12d04-e215-4b15-b236-64e96e8c77a1" }, { "name": "Post Subscription Items", "id": "428ee32f-eb60-461a-9e17-755d346532bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the subscription to modify.", "key": "subscription", "value": "" }, { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "key": "metadata[sint5]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "week" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "unspecified" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ] }, "description": "

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

" }, "response": [ { "id": "b339353f-f552-48e4-a5f2-2cf450f78443", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the subscription to modify.", "key": "subscription", "value": "" }, { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "key": "metadata[sint5]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "week" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "unspecified" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"Utb6e\": \"\",\n \"ipsumc36\": \"\",\n \"culpa0\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-b339353f-f552-48e4-a5f2-2cf450f78443" }, { "id": "32edc01e-740e-43d6-b525-c8357995a5a5", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the subscription to modify.", "key": "subscription", "value": "" }, { "key": "billing_thresholds[usage_gte]", "value": "" }, { "key": "expand", "value": "" }, { "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "key": "metadata[sint5]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "error_if_incomplete" }, { "description": "The ID of the price object.", "key": "price", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[currency]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[product]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval]", "value": "week" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[recurring][interval_count]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[tax_behavior]", "value": "unspecified" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount]", "value": "" }, { "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", "key": "price_data[unit_amount_decimal]", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" }, { "description": "The quantity you'd like to apply to the subscription item you're creating.", "key": "quantity", "value": "" }, { "key": "tax_rates", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_items" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-32edc01e-740e-43d6-b525-c8357995a5a5" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-428ee32f-eb60-461a-9e17-755d346532bf" } ], "id": "8009fa70-8fe7-4257-99d6-d9d556ad663f", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-8009fa70-8fe7-4257-99d6-d9d556ad663f" }, { "name": "subscription_schedules", "item": [ { "name": "{schedule}", "item": [ { "name": "cancel", "item": [ { "name": "Post Subscription Schedules Schedule Cancel", "id": "88d44958-f553-423f-a369-3c14bbd78ea4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "key": "invoice_now", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "cancel" ], "variable": [ { "id": "e08337bd-e35d-4641-a777-d6bb3f24a2fb", "key": "schedule", "value": "", "description": "(Required) " } ] }, "description": "

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

" }, "response": [ { "id": "6602dead-e19b-4a29-8b2e-b63c3ce542d9", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "key": "invoice_now", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "cancel" ], "variable": [ { "key": "schedule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"release\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"completed\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"qui99\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-6602dead-e19b-4a29-8b2e-b63c3ce542d9" }, { "id": "8979e673-2329-42d3-b64c-97bcaab7d4d4", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "key": "invoice_now", "value": "" }, { "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "cancel" ], "variable": [ { "key": "schedule" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-8979e673-2329-42d3-b64c-97bcaab7d4d4" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-88d44958-f553-423f-a369-3c14bbd78ea4" } ], "id": "7af78f36-5005-430c-b5a2-4111a24c6050", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-7af78f36-5005-430c-b5a2-4111a24c6050" }, { "name": "release", "item": [ { "name": "Post Subscription Schedules Schedule Release", "id": "181c45ec-beee-44f9-ab08-edf0f1921065", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "Keep any cancellation on the subscription that the schedule has set", "key": "preserve_cancel_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/release", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "release" ], "variable": [ { "id": "a9f79b74-5ac5-4020-ae67-93bd2ff42c2b", "key": "schedule", "value": "", "description": "(Required) " } ] }, "description": "

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription\u2019s ID to the released_subscription property.

" }, "response": [ { "id": "2949e62d-6837-4bb6-8918-a9933986f7ad", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "Keep any cancellation on the subscription that the schedule has set", "key": "preserve_cancel_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/release", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "release" ], "variable": [ { "key": "schedule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"release\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"completed\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"qui99\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-2949e62d-6837-4bb6-8918-a9933986f7ad" }, { "id": "948fdc0b-9321-429b-979c-d82d597fabf3", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "expand", "value": "" }, { "description": "Keep any cancellation on the subscription that the schedule has set", "key": "preserve_cancel_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule/release", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule", "release" ], "variable": [ { "key": "schedule" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-948fdc0b-9321-429b-979c-d82d597fabf3" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-181c45ec-beee-44f9-ab08-edf0f1921065" } ], "id": "3d5a74aa-a332-4e18-be6f-69e72f71d81c", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-3d5a74aa-a332-4e18-be6f-69e72f71d81c" }, { "name": "Get Subscription Schedules Schedule", "id": "31847a85-58ce-4ec1-999d-9274dd249fab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "id": "59d0fdb2-d4c9-4186-b8c8-7daf5cb099cf", "key": "schedule", "value": "", "description": "(Required) " } ] }, "description": "

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

" }, "response": [ { "id": "06e9b8e9-5df3-427a-a29b-02578879adfd", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "schedule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"release\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"completed\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"qui99\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-06e9b8e9-5df3-427a-a29b-02578879adfd" }, { "id": "4ddfc1c8-0a95-4a0f-ad92-4bf8fdfb9d5b", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "schedule" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-4ddfc1c8-0a95-4a0f-ad92-4bf8fdfb9d5b" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-31847a85-58ce-4ec1-999d-9274dd249fab" }, { "name": "Post Subscription Schedules Schedule", "id": "5d216709-55c9-4604-82ad-c00fbf77d103", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "phase_start" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "charge_automatically" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "cancel" }, { "key": "expand", "value": "" }, { "key": "metadata[tempor_0e]", "value": "" }, { "key": "phases", "value": "" }, { "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "variable": [ { "id": "d6e42f11-398a-4b65-b6d2-5ed4e5a9514b", "key": "schedule", "value": "", "description": "(Required) " } ] }, "description": "

Updates an existing subscription schedule.

" }, "response": [ { "id": "8a1eb0bd-e407-4c85-98e3-61872be6a6b4", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "phase_start" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "charge_automatically" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "cancel" }, { "key": "expand", "value": "" }, { "key": "metadata[tempor_0e]", "value": "" }, { "key": "phases", "value": "" }, { "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "variable": [ { "key": "schedule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"release\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"completed\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"qui99\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-8a1eb0bd-e407-4c85-98e3-61872be6a6b4" }, { "id": "0a5106d5-23fc-4f47-98e2-4badbac0d0c9", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "phase_start" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "charge_automatically" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "cancel" }, { "key": "expand", "value": "" }, { "key": "metadata[tempor_0e]", "value": "" }, { "key": "phases", "value": "" }, { "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules/:schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules", ":schedule" ], "variable": [ { "key": "schedule" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-0a5106d5-23fc-4f47-98e2-4badbac0d0c9" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-5d216709-55c9-4604-82ad-c00fbf77d103" } ], "id": "0bd95aaf-439e-41e8-8e74-81046af82d0d", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-0bd95aaf-439e-41e8-8e74-81046af82d0d" }, { "name": "Get Subscription Schedules", "id": "4c19dbe2-2fed-4b56-91e7-7be3cb336625", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules?canceled_at[gt]=&canceled_at[gte]=&canceled_at[lt]=&canceled_at[lte]=&completed_at[gt]=&completed_at[gte]=&completed_at[lt]=&completed_at[lte]=&created[gt]=&created[gte]=&created[lt]=&created[lte]=&customer=&ending_before=&expand=&limit=&released_at[gt]=&released_at[gte]=&released_at[lt]=&released_at[lte]=&scheduled=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ], "query": [ { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lte]", "value": "" }, { "description": "Only return subscription schedules for the given customer.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lte]", "value": "" }, { "description": "Only return subscription schedules that have not started yet.", "key": "scheduled", "value": "" }, { "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.", "key": "starting_after", "value": "" } ] }, "description": "

Retrieves the list of your subscription schedules.

" }, "response": [ { "id": "9575ee3b-606b-4c1b-aa54-3fd98f44c3f1", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules?canceled_at[gt]=&canceled_at[gte]=&canceled_at[lt]=&canceled_at[lte]=&completed_at[gt]=&completed_at[gte]=&completed_at[lt]=&completed_at[lte]=&created[gt]=&created[gte]=&created[lt]=&created[lte]=&customer=&ending_before=&expand=&limit=&released_at[gt]=&released_at[gte]=&released_at[lt]=&released_at[lte]=&scheduled=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ], "query": [ { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lte]", "value": "" }, { "description": "Only return subscription schedules for the given customer.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lte]", "value": "" }, { "description": "Only return subscription schedules that have not started yet.", "key": "scheduled", "value": "" }, { "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.", "key": "starting_after", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"cancel\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"not_started\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"incididunt88\": \"\",\n \"Ut25\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n },\n {\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"cancel\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"active\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"non_d19\": \"\",\n \"proident06\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"/v1/subscription_schedules\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9575ee3b-606b-4c1b-aa54-3fd98f44c3f1" }, { "id": "ae90eb0f-f32c-4839-bdba-a352bd486562", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules?canceled_at[gt]=&canceled_at[gte]=&canceled_at[lt]=&canceled_at[lte]=&completed_at[gt]=&completed_at[gte]=&completed_at[lt]=&completed_at[lte]=&created[gt]=&created[gte]=&created[lt]=&created[lte]=&customer=&ending_before=&expand=&limit=&released_at[gt]=&released_at[gte]=&released_at[lt]=&released_at[lte]=&scheduled=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ], "query": [ { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were created canceled the given date interval.", "key": "canceled_at[lte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[gte]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lt]", "value": "" }, { "description": "Only return subscription schedules that completed during the given date interval.", "key": "completed_at[lte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[gte]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lt]", "value": "" }, { "description": "Only return subscription schedules that were created during the given date interval.", "key": "created[lte]", "value": "" }, { "description": "Only return subscription schedules for the given customer.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[gte]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lt]", "value": "" }, { "description": "Only return subscription schedules that were released during the given date interval.", "key": "released_at[lte]", "value": "" }, { "description": "Only return subscription schedules that have not started yet.", "key": "scheduled", "value": "" }, { "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.", "key": "starting_after", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-ae90eb0f-f32c-4839-bdba-a352bd486562" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-4c19dbe2-2fed-4b56-91e7-7be3cb336625" }, { "name": "Post Subscription Schedules", "id": "e3852d72-5b83-4cff-a66e-fe26fbe9b548", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "The identifier of the customer to create the subscription schedule for.", "key": "customer", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "automatic" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "send_invoice" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "release" }, { "key": "expand", "value": "" }, { "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.", "key": "from_subscription", "value": "" }, { "key": "metadata[proident_]", "value": "" }, { "key": "metadata[mollit_0d7]", "value": "" }, { "key": "phases", "value": "" }, { "key": "start_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ] }, "description": "

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

" }, "response": [ { "id": "87830df5-76e4-42b7-98ec-83156bbbf84e", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "The identifier of the customer to create the subscription schedule for.", "key": "customer", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "automatic" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "send_invoice" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "release" }, { "key": "expand", "value": "" }, { "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.", "key": "from_subscription", "value": "" }, { "key": "metadata[proident_]", "value": "" }, { "key": "metadata[mollit_0d7]", "value": "" }, { "key": "phases", "value": "" }, { "key": "start_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": \"\",\n \"customer\": \"\",\n \"default_settings\": {\n \"value\": \"reference #/components/schemas/subscription_schedules_resource_default_settings not found in the OpenAPI spec\"\n },\n \"end_behavior\": \"release\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"subscription_schedule\",\n \"phases\": [\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/subscription_schedule_phase_configuration not found in the OpenAPI spec\"\n }\n ],\n \"status\": \"completed\",\n \"application\": \"\",\n \"canceled_at\": \"\",\n \"completed_at\": \"\",\n \"current_phase\": {\n \"value\": \"reference #/components/schemas/subscription_schedule_current_phase not found in the OpenAPI spec\"\n },\n \"metadata\": {\n \"qui99\": \"\"\n },\n \"released_at\": \"\",\n \"released_subscription\": \"\",\n \"subscription\": \"\",\n \"test_clock\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-87830df5-76e4-42b7-98ec-83156bbbf84e" }, { "id": "7bf875d4-0d61-4e84-b072-e056d4bd44d4", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "The identifier of the customer to create the subscription schedule for.", "key": "customer", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[application_fee_percent]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[automatic_tax][enabled]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_cycle_anchor]", "value": "automatic" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][amount_gte]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[collection_method]", "value": "send_invoice" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[default_payment_method]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[description]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[invoice_settings][days_until_due]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[on_behalf_of]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][destination]", "value": "" }, { "description": "Object representing the subscription schedule's default settings.", "key": "default_settings[transfer_data][amount_percent]", "value": "" }, { "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.", "key": "end_behavior", "value": "release" }, { "key": "expand", "value": "" }, { "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.", "key": "from_subscription", "value": "" }, { "key": "metadata[proident_]", "value": "" }, { "key": "metadata[mollit_0d7]", "value": "" }, { "key": "phases", "value": "" }, { "key": "start_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscription_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_schedules" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-7bf875d4-0d61-4e84-b072-e056d4bd44d4" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-e3852d72-5b83-4cff-a66e-fe26fbe9b548" } ], "id": "df3520f4-b99b-4f7e-9d61-45058923ed21", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-df3520f4-b99b-4f7e-9d61-45058923ed21" }, { "name": "subscriptions", "item": [ { "name": "search", "item": [ { "name": "Get Subscriptions Search", "id": "8f559601-3d4e-4019-883c-cf71da053e3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/search?expand=&limit=&page=&query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", "search" ], "query": [ { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "key": "page", "value": "" }, { "description": "(Required) The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).", "key": "query", "value": "" } ] }, "description": "

Search for subscriptions you\u2019ve previously created using Stripe\u2019s Search Query Language.\nDon\u2019t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

" }, "response": [ { "id": "63031076-282e-4213-a439-56fec70b4137", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/search?expand=&limit=&page=&query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", "search" ], "query": [ { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "key": "page", "value": "" }, { "description": "(Required) The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).", "key": "query", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"send_invoice\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"in_e\": \"\",\n \"anim_c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"amet1\": \"\",\n \"fugiat_4\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"minim_e_\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"unpaid\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n },\n {\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"elit711\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"do_0\": \"\",\n \"Utbfe\": \"\",\n \"culpa_61\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"sunt47\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"unpaid\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"object\": \"search_result\",\n \"url\": \"\",\n \"next_page\": \"\",\n \"total_count\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-63031076-282e-4213-a439-56fec70b4137" }, { "id": "d821c01b-2815-466d-af19-d47a12077334", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/search?expand=&limit=&page=&query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", "search" ], "query": [ { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", "key": "page", "value": "" }, { "description": "(Required) The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).", "key": "query", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-d821c01b-2815-466d-af19-d47a12077334" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-8f559601-3d4e-4019-883c-cf71da053e3e" } ], "id": "85fc8581-3ee9-4589-a81a-473a39b356d5", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-85fc8581-3ee9-4589-a81a-473a39b356d5" }, { "name": "{subscription_exposed_id}", "item": [ { "name": "discount", "item": [ { "name": "Delete Subscriptions Subscription Exposed Id Discount", "id": "0953c12e-08ee-41ce-a921-3ffdf742ecee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id/discount", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id", "discount" ], "variable": [ { "id": "d9935001-8d90-4008-af3f-13ed4cc9d251", "key": "subscription_exposed_id", "value": "", "description": "(Required) " } ] }, "description": "

Removes the currently applied discount on a subscription.

" }, "response": [ { "id": "d58fa1b0-a71b-497b-9010-bc41cc471715", "name": "Successful response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id/discount", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id", "discount" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"coupon\": {\n \"value\": \"reference #/components/schemas/coupon not found in the OpenAPI spec\"\n },\n \"deleted\": true,\n \"id\": \"\",\n \"object\": \"discount\",\n \"start\": \"\",\n \"checkout_session\": \"\",\n \"customer\": \"\",\n \"invoice\": \"\",\n \"invoice_item\": \"\",\n \"promotion_code\": \"\",\n \"subscription\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-d58fa1b0-a71b-497b-9010-bc41cc471715" }, { "id": "5a65b9a5-2520-4b18-8f4b-994b8d3d0395", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id/discount", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id", "discount" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-5a65b9a5-2520-4b18-8f4b-994b8d3d0395" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-0953c12e-08ee-41ce-a921-3ffdf742ecee" } ], "id": "31272145-8f9d-4278-9c79-bfdedba31047", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-31272145-8f9d-4278-9c79-bfdedba31047" }, { "name": "Delete Subscriptions Subscription Exposed Id", "id": "c7e819e0-7b74-413b-b667-fa3f948a4fdf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "too_expensive" }, { "key": "expand", "value": "" }, { "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", "key": "invoice_now", "value": "" }, { "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "id": "56989545-7dd6-4315-a3fe-5a83f0cb6d5b", "key": "subscription_exposed_id", "value": "", "description": "(Required) " } ] }, "description": "

Cancels a customer\u2019s subscription immediately. The customer will not be charged again for the subscription.

\n\n

Note, however, that any pending invoice items that you\u2019ve created will still be charged for at the end of the period, unless manually deleted. If you\u2019ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

\n\n

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

" }, "response": [ { "id": "5f7c14ba-aa34-4ab7-b6bc-c9608be30447", "name": "Successful response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "too_expensive" }, { "key": "expand", "value": "" }, { "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", "key": "invoice_now", "value": "" }, { "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_\": \"\",\n \"dolor_3c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ida4\": \"\",\n \"id8\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"Duis9\": \"\",\n \"ipsuma2\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"incomplete_expired\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-5f7c14ba-aa34-4ab7-b6bc-c9608be30447" }, { "id": "d301d519-687a-41b7-9eaa-5164d38cd1a4", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "too_expensive" }, { "key": "expand", "value": "" }, { "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", "key": "invoice_now", "value": "" }, { "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end.", "key": "prorate", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-d301d519-687a-41b7-9eaa-5164d38cd1a4" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-c7e819e0-7b74-413b-b667-fa3f948a4fdf" }, { "name": "Get Subscriptions Subscription Exposed Id", "id": "1b4d29de-d994-4f5b-82ae-7dd06f2effc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "id": "63aebb1d-487a-45b8-8e25-1a75d2389e39", "key": "subscription_exposed_id", "value": "", "description": "(Required) " } ] }, "description": "

Retrieves the subscription with the given ID.

" }, "response": [ { "id": "87c413b3-e050-4459-b497-34d385cb5883", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_\": \"\",\n \"dolor_3c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ida4\": \"\",\n \"id8\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"Duis9\": \"\",\n \"ipsuma2\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"incomplete_expired\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-87c413b3-e050-4459-b497-34d385cb5883" }, { "id": "99205252-7ba2-443f-9094-77d3d8e1c63e", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-99205252-7ba2-443f-9094-77d3d8e1c63e" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-1b4d29de-d994-4f5b-82ae-7dd06f2effc6" }, { "name": "Post Subscriptions Subscription Exposed Id", "id": "377d2f6d-7163-4c37-8cce-923567353f1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "switched_service" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[velit54]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "key": "pause_collection[behavior]", "value": "keep_as_draft" }, { "key": "pause_collection[resumes_at]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "pending_if_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "personal" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "instant" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "fr" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "fixed" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "diners" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "any" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "payment_method" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "acss_debit" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "day" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "key": "proration_date", "value": "" }, { "key": "transfer_data[destination]", "value": "" }, { "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "pause" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "id": "c7ad2b26-7088-4cb6-8ca3-8f2f06f35bdb", "key": "subscription_exposed_id", "value": "", "description": "(Required) " } ] }, "description": "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they\u2019ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they\u2019ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month\u2019s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n
    \n
  • The billing interval is changed (for example, from monthly to yearly).
    • \n
  • The subscription moves from free to paid, or paid to free.
    • \n
  • A trial starts or ends.
    • \n
\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription\u2019s renewal date, you need to manually invoice the customer.

\n\n

If you don\u2019t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don\u2019t generate any credits for the old subscription\u2019s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

" }, "response": [ { "id": "3925bffd-0305-408d-a2c6-cf211a4c1fbd", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "switched_service" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[velit54]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "key": "pause_collection[behavior]", "value": "keep_as_draft" }, { "key": "pause_collection[resumes_at]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "pending_if_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "personal" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "instant" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "fr" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "fixed" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "diners" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "any" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "payment_method" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "acss_debit" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "day" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "key": "proration_date", "value": "" }, { "key": "transfer_data[destination]", "value": "" }, { "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "pause" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_\": \"\",\n \"dolor_3c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ida4\": \"\",\n \"id8\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"Duis9\": \"\",\n \"ipsuma2\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"incomplete_expired\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-3925bffd-0305-408d-a2c6-cf211a4c1fbd" }, { "id": "9e6d9eb3-b3c7-462e-bfce-4029210ab4b2", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[comment]", "value": "" }, { "description": "Details about why this subscription was cancelled", "key": "cancellation_details[feedback]", "value": "switched_service" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[velit54]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "key": "pause_collection[behavior]", "value": "keep_as_draft" }, { "key": "pause_collection[resumes_at]", "value": "" }, { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", "key": "payment_behavior", "value": "pending_if_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "personal" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "instant" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "fr" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "fixed" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "diners" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "any" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "payment_method" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "acss_debit" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "day" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "none" }, { "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", "key": "proration_date", "value": "" }, { "key": "transfer_data[destination]", "value": "" }, { "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "pause" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription_exposed_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription_exposed_id" ], "variable": [ { "key": "subscription_exposed_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9e6d9eb3-b3c7-462e-bfce-4029210ab4b2" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-377d2f6d-7163-4c37-8cce-923567353f1c" } ], "id": "d20b9871-70d3-4795-961d-b96f739b11b3", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-d20b9871-70d3-4795-961d-b96f739b11b3" }, { "name": "{subscription}", "item": [ { "name": "resume", "item": [ { "name": "Post Subscriptions Subscription Resume", "id": "ab0d516a-a52a-412a-a1c3-cb551876324d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "expand", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription", "resume" ], "variable": [ { "id": "1feac5f2-86b1-4d6a-922a-32ea0d6ef1af", "key": "subscription", "value": "", "description": "(Required) " } ] }, "description": "

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

" }, "response": [ { "id": "f23b8297-ad1c-41a2-beb2-a2bda8cb4bb9", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "expand", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription", "resume" ], "variable": [ { "key": "subscription" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_\": \"\",\n \"dolor_3c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ida4\": \"\",\n \"id8\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"Duis9\": \"\",\n \"ipsuma2\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"incomplete_expired\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-f23b8297-ad1c-41a2-beb2-a2bda8cb4bb9" }, { "id": "dbd737d3-c825-436e-9dc5-193827174e14", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "key": "billing_cycle_anchor", "value": "now" }, { "key": "expand", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "key": "proration_behavior", "value": "always_invoice" }, { "description": "If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", "key": "proration_date", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions/:subscription/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":subscription", "resume" ], "variable": [ { "key": "subscription" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-dbd737d3-c825-436e-9dc5-193827174e14" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-ab0d516a-a52a-412a-a1c3-cb551876324d" } ], "id": "1014efa0-f25d-4b2e-96ef-192499be5835", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-1014efa0-f25d-4b2e-96ef-192499be5835" } ], "id": "29ce3208-6e12-4022-8b89-94c58ea35c99", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-29ce3208-6e12-4022-8b89-94c58ea35c99" }, { "name": "Get Subscriptions", "id": "c13b2495-0ab2-4345-b127-579eb16aa115", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions?automatic_tax[enabled]=&collection_method=charge_automatically&created[gt]=&created[gte]=&created[lt]=&created[lte]=¤t_period_end[gt]=¤t_period_end[gte]=¤t_period_end[lt]=¤t_period_end[lte]=¤t_period_start[gt]=¤t_period_start[gte]=¤t_period_start[lt]=¤t_period_start[lte]=&customer=&ending_before=&expand=&limit=&price=&starting_after=&status=incomplete_expired&test_clock=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ], "query": [ { "description": "Filter subscriptions by their automatic tax settings.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.", "key": "collection_method", "value": "charge_automatically" }, { "key": "created[gt]", "value": "" }, { "key": "created[gte]", "value": "" }, { "key": "created[lt]", "value": "" }, { "key": "created[lte]", "value": "" }, { "key": "current_period_end[gt]", "value": "" }, { "key": "current_period_end[gte]", "value": "" }, { "key": "current_period_end[lt]", "value": "" }, { "key": "current_period_end[lte]", "value": "" }, { "key": "current_period_start[gt]", "value": "" }, { "key": "current_period_start[gte]", "value": "" }, { "key": "current_period_start[lt]", "value": "" }, { "key": "current_period_start[lte]", "value": "" }, { "description": "The ID of the customer whose subscriptions will be retrieved.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Filter for subscriptions that contain this recurring price ID.", "key": "price", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.", "key": "status", "value": "incomplete_expired" }, { "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.", "key": "test_clock", "value": "" } ] }, "description": "

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

" }, "response": [ { "id": "c2ada21f-e9ed-42df-995a-8e55803033d7", "name": "Successful response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions?automatic_tax[enabled]=&collection_method=charge_automatically&created[gt]=&created[gte]=&created[lt]=&created[lte]=¤t_period_end[gt]=¤t_period_end[gte]=¤t_period_end[lt]=¤t_period_end[lte]=¤t_period_start[gt]=¤t_period_start[gte]=¤t_period_start[lt]=¤t_period_start[lte]=&customer=&ending_before=&expand=&limit=&price=&starting_after=&status=incomplete_expired&test_clock=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ], "query": [ { "description": "Filter subscriptions by their automatic tax settings.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.", "key": "collection_method", "value": "charge_automatically" }, { "key": "created[gt]", "value": "" }, { "key": "created[gte]", "value": "" }, { "key": "created[lt]", "value": "" }, { "key": "created[lte]", "value": "" }, { "key": "current_period_end[gt]", "value": "" }, { "key": "current_period_end[gte]", "value": "" }, { "key": "current_period_end[lt]", "value": "" }, { "key": "current_period_end[lte]", "value": "" }, { "key": "current_period_start[gt]", "value": "" }, { "key": "current_period_start[gte]", "value": "" }, { "key": "current_period_start[lt]", "value": "" }, { "key": "current_period_start[lte]", "value": "" }, { "description": "The ID of the customer whose subscriptions will be retrieved.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Filter for subscriptions that contain this recurring price ID.", "key": "price", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.", "key": "status", "value": "incomplete_expired" }, { "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.", "key": "test_clock", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"voluptate21c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"sit0\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"reprehenderit79\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"trialing\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n },\n {\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"send_invoice\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"est_5b\": \"\",\n \"aliquipf\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"fugiat_42\": \"\",\n \"commodo_a_5\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"voluptate0\": \"\",\n \"aliquip_d\": \"\",\n \"laboris_6cf\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"past_due\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"/v1/subscriptions\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-c2ada21f-e9ed-42df-995a-8e55803033d7" }, { "id": "f20e5b88-e32a-4e78-b9d6-8b58db0108b4", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions?automatic_tax[enabled]=&collection_method=charge_automatically&created[gt]=&created[gte]=&created[lt]=&created[lte]=¤t_period_end[gt]=¤t_period_end[gte]=¤t_period_end[lt]=¤t_period_end[lte]=¤t_period_start[gt]=¤t_period_start[gte]=¤t_period_start[lt]=¤t_period_start[lte]=&customer=&ending_before=&expand=&limit=&price=&starting_after=&status=incomplete_expired&test_clock=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ], "query": [ { "description": "Filter subscriptions by their automatic tax settings.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.", "key": "collection_method", "value": "charge_automatically" }, { "key": "created[gt]", "value": "" }, { "key": "created[gte]", "value": "" }, { "key": "created[lt]", "value": "" }, { "key": "created[lte]", "value": "" }, { "key": "current_period_end[gt]", "value": "" }, { "key": "current_period_end[gte]", "value": "" }, { "key": "current_period_end[lt]", "value": "" }, { "key": "current_period_end[lte]", "value": "" }, { "key": "current_period_start[gt]", "value": "" }, { "key": "current_period_start[gte]", "value": "" }, { "key": "current_period_start[lt]", "value": "" }, { "key": "current_period_start[lte]", "value": "" }, { "description": "The ID of the customer whose subscriptions will be retrieved.", "key": "customer", "value": "" }, { "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.", "key": "ending_before", "value": "" }, { "key": "expand", "value": "" }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "key": "limit", "value": "" }, { "description": "Filter for subscriptions that contain this recurring price ID.", "key": "price", "value": "" }, { "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.", "key": "starting_after", "value": "" }, { "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.", "key": "status", "value": "incomplete_expired" }, { "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.", "key": "test_clock", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-f20e5b88-e32a-4e78-b9d6-8b58db0108b4" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-c13b2495-0ab2-4345-b127-579eb16aa115" }, { "name": "Post Subscriptions", "id": "4a6fa201-2e3d-43d6-a77d-fdc84f5eb4e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the customer to subscribe.", "key": "customer", "value": "" }, { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "key": "backdate_start_date", "value": "" }, { "description": "A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", "key": "billing_cycle_anchor", "value": "" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "key": "currency", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[pariatur_3]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.", "key": "payment_behavior", "value": "default_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "business" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "de" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "maximum" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "visa" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "balances" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "ownership" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "microdeposits" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "customer_balance" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "month" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[destination]", "value": "" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_period_days", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "create_invoice" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ] }, "description": "

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

\n\n

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.

\n\n

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.

" }, "response": [ { "id": "9a58dce7-8935-4b4a-a1a4-a4a18ddccceb", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the customer to subscribe.", "key": "customer", "value": "" }, { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "key": "backdate_start_date", "value": "" }, { "description": "A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", "key": "billing_cycle_anchor", "value": "" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "key": "currency", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[pariatur_3]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.", "key": "payment_behavior", "value": "default_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "business" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "de" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "maximum" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "visa" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "balances" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "ownership" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "microdeposits" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "customer_balance" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "month" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[destination]", "value": "" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_period_days", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "create_invoice" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"automatic_tax\": {\n \"value\": \"reference #/components/schemas/subscription_automatic_tax not found in the OpenAPI spec\"\n },\n \"billing_cycle_anchor\": \"\",\n \"cancel_at_period_end\": \"\",\n \"collection_method\": \"charge_automatically\",\n \"created\": \"\",\n \"currency\": \"\",\n \"current_period_end\": \"\",\n \"current_period_start\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"items\": {\n \"data\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ut_\": \"\",\n \"dolor_3c\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"ida4\": \"\",\n \"id8\": \"\"\n },\n \"object\": \"subscription_item\",\n \"price\": {\n \"value\": \"reference #/components/schemas/price not found in the OpenAPI spec\"\n },\n \"subscription\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_item_billing_thresholds not found in the OpenAPI spec\"\n },\n \"quantity\": \"\",\n \"tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ]\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"\"\n },\n \"livemode\": \"\",\n \"metadata\": {\n \"Duis9\": \"\",\n \"ipsuma2\": \"\"\n },\n \"object\": \"subscription\",\n \"start_date\": \"\",\n \"status\": \"incomplete_expired\",\n \"application\": \"\",\n \"application_fee_percent\": \"\",\n \"billing_thresholds\": {\n \"value\": \"reference #/components/schemas/subscription_billing_thresholds not found in the OpenAPI spec\"\n },\n \"cancel_at\": \"\",\n \"canceled_at\": \"\",\n \"cancellation_details\": {\n \"value\": \"reference #/components/schemas/cancellation_details not found in the OpenAPI spec\"\n },\n \"days_until_due\": \"\",\n \"default_payment_method\": \"\",\n \"default_source\": \"\",\n \"default_tax_rates\": [\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/tax_rate not found in the OpenAPI spec\"\n }\n ],\n \"description\": \"\",\n \"discount\": {\n \"value\": \"reference #/components/schemas/discount not found in the OpenAPI spec\"\n },\n \"ended_at\": \"\",\n \"latest_invoice\": \"\",\n \"next_pending_invoice_item_invoice\": \"\",\n \"on_behalf_of\": \"\",\n \"pause_collection\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pause_collection not found in the OpenAPI spec\"\n },\n \"payment_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_payment_settings not found in the OpenAPI spec\"\n },\n \"pending_invoice_item_interval\": {\n \"value\": \"reference #/components/schemas/subscription_pending_invoice_item_interval not found in the OpenAPI spec\"\n },\n \"pending_setup_intent\": \"\",\n \"pending_update\": {\n \"value\": \"reference #/components/schemas/subscriptions_resource_pending_update not found in the OpenAPI spec\"\n },\n \"schedule\": \"\",\n \"test_clock\": \"\",\n \"transfer_data\": {\n \"value\": \"reference #/components/schemas/subscription_transfer_data not found in the OpenAPI spec\"\n },\n \"trial_end\": \"\",\n \"trial_settings\": {\n \"value\": \"reference #/components/schemas/subscriptions_trials_resource_trial_settings not found in the OpenAPI spec\"\n },\n \"trial_start\": \"\"\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-9a58dce7-8935-4b4a-a1a4-a4a18ddccceb" }, { "id": "a149ac6b-cf57-4c01-ad6c-c3830d56d084", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The identifier of the customer to subscribe.", "key": "customer", "value": "" }, { "key": "add_invoice_items", "value": "" }, { "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", "key": "application_fee_percent", "value": "" }, { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", "key": "automatic_tax[enabled]", "value": "" }, { "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", "key": "backdate_start_date", "value": "" }, { "description": "A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", "key": "billing_cycle_anchor", "value": "" }, { "key": "billing_thresholds[amount_gte]", "value": "" }, { "key": "billing_thresholds[reset_billing_cycle_anchor]", "value": "" }, { "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", "key": "cancel_at", "value": "" }, { "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", "key": "cancel_at_period_end", "value": "" }, { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", "key": "collection_method", "value": "charge_automatically" }, { "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "key": "coupon", "value": "" }, { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "key": "currency", "value": "" }, { "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", "key": "days_until_due", "value": "" }, { "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_payment_method", "value": "" }, { "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).", "key": "default_source", "value": "" }, { "key": "default_tax_rates", "value": "" }, { "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.", "key": "description", "value": "" }, { "key": "expand", "value": "" }, { "key": "items", "value": "" }, { "key": "metadata[pariatur_3]", "value": "" }, { "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", "key": "off_session", "value": "" }, { "key": "on_behalf_of", "value": "" }, { "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription\u2019s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.", "key": "payment_behavior", "value": "default_incomplete" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value": "business" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][acss_debit][verification_method]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][bancontact][preferred_language]", "value": "de" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][amount_type]", "value": "maximum" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][mandate_options][description]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][network]", "value": "visa" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][card][request_three_d_secure]", "value": "automatic" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][customer_balance][funding_type]", "value": "" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value": "balances" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value": "ownership" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value": "transactions" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_options][us_bank_account][verification_method]", "value": "microdeposits" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][0]", "value": "customer_balance" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[payment_method_types][1]", "value": "link" }, { "description": "Payment settings to pass to invoices created by the subscription.", "key": "payment_settings[save_default_payment_method]", "value": "off" }, { "key": "pending_invoice_item_interval[interval]", "value": "month" }, { "key": "pending_invoice_item_interval[interval_count]", "value": "" }, { "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", "key": "promotion_code", "value": "" }, { "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "key": "proration_behavior", "value": "create_prorations" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[destination]", "value": "" }, { "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", "key": "transfer_data[amount_percent]", "value": "" }, { "key": "trial_end", "value": "now" }, { "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_from_plan", "value": "" }, { "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", "key": "trial_period_days", "value": "" }, { "description": "Settings related to subscription trials.", "key": "trial_settings[end_behavior][missing_payment_method]", "value": "create_invoice" } ] }, "url": { "raw": "{{baseUrl}}/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"value\": \"reference #/components/schemas/api_errors not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-a149ac6b-cf57-4c01-ad6c-c3830d56d084" } ], "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-4a6fa201-2e3d-43d6-a77d-fdc84f5eb4e7" } ], "id": "f4ff6186-fc01-4648-997e-4ef2a39ab96d", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-f4ff6186-fc01-4648-997e-4ef2a39ab96d" } ], "id": "26d0e455-6514-4bc3-b7af-f1c44d9cdffa", "createdAt": "2026-06-05T13:24:22.000Z", "updatedAt": "2026-06-05T13:24:22.000Z", "uid": "35240-26d0e455-6514-4bc3-b7af-f1c44d9cdffa" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.stripe.com/" } ] }