{ "info": { "_postman_id": "310d60e2-02dd-418f-8e2a-b2b4d289c9f4", "name": "Stripe Billing API", "description": "Create and manage subscriptions, recurring payments, and recurring revenue.\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:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "lastUpdatedBy": "35240", "uid": "35240-310d60e2-02dd-418f-8e2a-b2b4d289c9f4" }, "item": [ { "name": "v1", "item": [ { "name": "billing_portal", "item": [ { "name": "configurations", "item": [ { "name": "{configuration}", "item": [ { "name": "Stripe Get Billing Portal Configurations Configuration", "id": "ae254eac-57bb-45f6-9ebc-400173291fa8", "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/billing_portal/configurations/:configuration?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "id": "96f506e0-9249-4169-90c7-b6b943601f75", "key": "configuration", "value": "", "description": "(Required) " } ] }, "description": "

Retrieves a configuration that describes the functionality of the customer portal.

" }, "response": [ { "id": "19cf2edf-7b0a-4ef6-95d8-cb3159a83584", "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/billing_portal/configurations/:configuration?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "configuration" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"active\": \"\",\n \"business_profile\": {\n \"value\": \"reference #/components/schemas/portal_business_profile not found in the OpenAPI spec\"\n },\n \"created\": \"\",\n \"features\": {\n \"value\": \"reference #/components/schemas/portal_features not found in the OpenAPI spec\"\n },\n \"id\": \"\",\n \"is_default\": \"\",\n \"livemode\": \"\",\n \"login_page\": {\n \"value\": \"reference #/components/schemas/portal_login_page not found in the OpenAPI spec\"\n },\n \"object\": \"billing_portal.configuration\",\n \"updated\": \"\",\n \"application\": \"\",\n \"default_return_url\": \"\",\n \"metadata\": {\n \"nulla_ce\": \"\",\n \"ipsum_f\": \"\"\n }\n}", "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-19cf2edf-7b0a-4ef6-95d8-cb3159a83584" }, { "id": "c9f33600-f915-4985-b082-f9d45373abd6", "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/billing_portal/configurations/:configuration?expand=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "query": [ { "key": "expand", "value": "" } ], "variable": [ { "key": "configuration" } ] } }, "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:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-c9f33600-f915-4985-b082-f9d45373abd6" } ], "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-ae254eac-57bb-45f6-9ebc-400173291fa8" }, { "name": "Stripe Post Billing Portal Configurations Configuration", "id": "46fb2531-f473-4742-b018-fcc16d934982", "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": "Whether the configuration is active and can be used to create portal sessions.", "key": "active", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "tax_id" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "immediately" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "always_invoice" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "create_prorations" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "value": "" }, { "key": "metadata[nisib81]", "value": "" }, { "key": "metadata[cillumd9]", "value": "" }, { "key": "metadata[aliqua3c]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations/:configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "variable": [ { "id": "f03916c2-1970-4a11-b763-0c70784d7cc2", "key": "configuration", "value": "", "description": "(Required) " } ] }, "description": "

Updates a configuration that describes the functionality of the customer portal.

" }, "response": [ { "id": "ac51bf5b-cec1-4e63-90e9-1fd05b42fb25", "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": "Whether the configuration is active and can be used to create portal sessions.", "key": "active", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "tax_id" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "immediately" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "always_invoice" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "create_prorations" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "value": "" }, { "key": "metadata[nisib81]", "value": "" }, { "key": "metadata[cillumd9]", "value": "" }, { "key": "metadata[aliqua3c]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations/:configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "variable": [ { "key": "configuration" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"active\": \"\",\n \"business_profile\": {\n \"value\": \"reference #/components/schemas/portal_business_profile not found in the OpenAPI spec\"\n },\n \"created\": \"\",\n \"features\": {\n \"value\": \"reference #/components/schemas/portal_features not found in the OpenAPI spec\"\n },\n \"id\": \"\",\n \"is_default\": \"\",\n \"livemode\": \"\",\n \"login_page\": {\n \"value\": \"reference #/components/schemas/portal_login_page not found in the OpenAPI spec\"\n },\n \"object\": \"billing_portal.configuration\",\n \"updated\": \"\",\n \"application\": \"\",\n \"default_return_url\": \"\",\n \"metadata\": {\n \"nulla_ce\": \"\",\n \"ipsum_f\": \"\"\n }\n}", "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-ac51bf5b-cec1-4e63-90e9-1fd05b42fb25" }, { "id": "6397f3ff-a1f3-4fd8-ba72-0f233063fb71", "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": "Whether the configuration is active and can be used to create portal sessions.", "key": "active", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "tax_id" }, { "description": "Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "switched_service" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "immediately" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "always_invoice" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "price" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "create_prorations" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "value": "" }, { "key": "metadata[nisib81]", "value": "" }, { "key": "metadata[cillumd9]", "value": "" }, { "key": "metadata[aliqua3c]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations/:configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations", ":configuration" ], "variable": [ { "key": "configuration" } ] } }, "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:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-6397f3ff-a1f3-4fd8-ba72-0f233063fb71" } ], "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-46fb2531-f473-4742-b018-fcc16d934982" } ], "id": "6cccabb4-3c81-4981-8120-7d31b104786f", "createdAt": "2026-06-05T13:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "uid": "35240-6cccabb4-3c81-4981-8120-7d31b104786f" }, { "name": "Stripe Get Billing Portal Configurations", "id": "ec4a5a5b-71ef-4526-b6be-96af893a778d", "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/billing_portal/configurations?active=&ending_before=&expand=&is_default=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ], "query": [ { "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", "key": "active", "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": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", "key": "is_default", "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": "

Returns a list of configurations that describe the functionality of the customer portal.

" }, "response": [ { "id": "acd8f654-b8a1-4efe-9d8c-6a3b639c0ef1", "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/billing_portal/configurations?active=&ending_before=&expand=&is_default=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ], "query": [ { "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", "key": "active", "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": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", "key": "is_default", "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": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"active\": \"\",\n \"business_profile\": {\n \"value\": \"reference #/components/schemas/portal_business_profile not found in the OpenAPI spec\"\n },\n \"created\": \"\",\n \"features\": {\n \"value\": \"reference #/components/schemas/portal_features not found in the OpenAPI spec\"\n },\n \"id\": \"\",\n \"is_default\": \"\",\n \"livemode\": \"\",\n \"login_page\": {\n \"value\": \"reference #/components/schemas/portal_login_page not found in the OpenAPI spec\"\n },\n \"object\": \"billing_portal.configuration\",\n \"updated\": \"\",\n \"application\": \"\",\n \"default_return_url\": \"\",\n \"metadata\": {\n \"laborum_e9\": \"\",\n \"esse64e\": \"\",\n \"eiusmod_c38\": \"\",\n \"est9\": \"\"\n }\n },\n {\n \"active\": \"\",\n \"business_profile\": {\n \"value\": \"reference #/components/schemas/portal_business_profile not found in the OpenAPI spec\"\n },\n \"created\": \"\",\n \"features\": {\n \"value\": \"reference #/components/schemas/portal_features not found in the OpenAPI spec\"\n },\n \"id\": \"\",\n \"is_default\": \"\",\n \"livemode\": \"\",\n \"login_page\": {\n \"value\": \"reference #/components/schemas/portal_login_page not found in the OpenAPI spec\"\n },\n \"object\": \"billing_portal.configuration\",\n \"updated\": \"\",\n \"application\": \"\",\n \"default_return_url\": \"\",\n \"metadata\": {\n \"mollit_2\": \"\",\n \"Ut_20\": \"\",\n \"nostrud2\": \"\"\n }\n }\n ],\n \"has_more\": \"\",\n \"object\": \"list\",\n \"url\": \"/v1/billing_portal/configurations\"\n}", "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-acd8f654-b8a1-4efe-9d8c-6a3b639c0ef1" }, { "id": "1fdf1e0b-3de6-42f4-93b5-98eaaa16d6fa", "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/billing_portal/configurations?active=&ending_before=&expand=&is_default=&limit=&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ], "query": [ { "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", "key": "active", "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": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", "key": "is_default", "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": "" } ] } }, "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:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-1fdf1e0b-3de6-42f4-93b5-98eaaa16d6fa" } ], "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-ec4a5a5b-71ef-4526-b6be-96af893a778d" }, { "name": "Stripe Post Billing Portal Configurations", "id": "e701a380-f682-48e5-aea1-f4ea614cd41f", "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 business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "customer_service" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "low_quality" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "at_period_end" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "create_prorations" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "none" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "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[sint61]", "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[pariaturb79]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ] }, "description": "

Creates a configuration that describes the functionality and behavior of a PortalSession

" }, "response": [ { "id": "7ab25d01-807a-43be-a132-d5c68b867167", "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 business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "customer_service" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "low_quality" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "at_period_end" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "create_prorations" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "none" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "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[sint61]", "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[pariaturb79]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"active\": \"\",\n \"business_profile\": {\n \"value\": \"reference #/components/schemas/portal_business_profile not found in the OpenAPI spec\"\n },\n \"created\": \"\",\n \"features\": {\n \"value\": \"reference #/components/schemas/portal_features not found in the OpenAPI spec\"\n },\n \"id\": \"\",\n \"is_default\": \"\",\n \"livemode\": \"\",\n \"login_page\": {\n \"value\": \"reference #/components/schemas/portal_login_page not found in the OpenAPI spec\"\n },\n \"object\": \"billing_portal.configuration\",\n \"updated\": \"\",\n \"application\": \"\",\n \"default_return_url\": \"\",\n \"metadata\": {\n \"nulla_ce\": \"\",\n \"ipsum_f\": \"\"\n }\n}", "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-7ab25d01-807a-43be-a132-d5c68b867167" }, { "id": "76bb4324-83dc-4675-b099-422fad63da2b", "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 business information shown to customers in the portal.", "key": "business_profile[headline]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[privacy_policy_url]", "value": "" }, { "description": "(Required) The business information shown to customers in the portal.", "key": "business_profile[terms_of_service_url]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][0]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[customer_update][allowed_updates][1]", "value": "phone" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[invoice_history][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[payment_method_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][0]", "value": "customer_service" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][cancellation_reason][options][1]", "value": "low_quality" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][mode]", "value": "at_period_end" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_cancel][proration_behavior]", "value": "create_prorations" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_pause][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][0]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][default_allowed_updates][1]", "value": "quantity" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][enabled]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][0][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][0]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][prices][1]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][products][1][product]", "value": "" }, { "description": "(Required) Information about the features available in the portal.", "key": "features[subscription_update][proration_behavior]", "value": "none" }, { "key": "default_return_url", "value": "" }, { "key": "expand", "value": "" }, { "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).", "key": "login_page[enabled]", "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[sint61]", "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[pariaturb79]", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/configurations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "configurations" ] } }, "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:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-76bb4324-83dc-4675-b099-422fad63da2b" } ], "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-e701a380-f682-48e5-aea1-f4ea614cd41f" } ], "id": "f5057c56-90e3-4dd1-ba69-206f04c77c6c", "createdAt": "2026-06-05T13:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "uid": "35240-f5057c56-90e3-4dd1-ba69-206f04c77c6c" }, { "name": "sessions", "item": [ { "name": "Stripe Post Billing Portal Sessions", "id": "1866062f-41ee-4aef-9ca2-e826542a684b", "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 ID of an existing customer.", "key": "customer", "value": "" }, { "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.", "key": "configuration", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[type]", "value": "subscription_update" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][type]", "value": "hosted_confirmation" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][hosted_confirmation][custom_message]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][redirect][return_url]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][coupon_offer][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][type]", "value": "coupon_offer" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][promotion_code]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][promotion_code]", "value": "" }, { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer\u2019s `preferred_locales` or browser\u2019s locale is used.", "key": "locale", "value": "fr-CA" }, { "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "key": "on_behalf_of", "value": "" }, { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.", "key": "return_url", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "sessions" ] }, "description": "

Creates a session of the customer portal.

" }, "response": [ { "id": "fa593948-9bd9-48c8-afd5-305e7cecc84d", "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 ID of an existing customer.", "key": "customer", "value": "" }, { "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.", "key": "configuration", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[type]", "value": "subscription_update" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][type]", "value": "hosted_confirmation" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][hosted_confirmation][custom_message]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][redirect][return_url]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][coupon_offer][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][type]", "value": "coupon_offer" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][promotion_code]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][promotion_code]", "value": "" }, { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer\u2019s `preferred_locales` or browser\u2019s locale is used.", "key": "locale", "value": "fr-CA" }, { "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "key": "on_behalf_of", "value": "" }, { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.", "key": "return_url", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "sessions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": \"\",\n \"created\": \"\",\n \"customer\": \"\",\n \"id\": \"\",\n \"livemode\": \"\",\n \"object\": \"billing_portal.session\",\n \"url\": \"\",\n \"flow\": {\n \"value\": \"reference #/components/schemas/portal_flows_flow not found in the OpenAPI spec\"\n },\n \"locale\": \"en-GB\",\n \"on_behalf_of\": \"\",\n \"return_url\": \"\"\n}", "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-fa593948-9bd9-48c8-afd5-305e7cecc84d" }, { "id": "24342aa8-ac71-46d9-bd43-dff88a2b8ad6", "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 ID of an existing customer.", "key": "customer", "value": "" }, { "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.", "key": "configuration", "value": "" }, { "key": "expand", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[type]", "value": "subscription_update" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][type]", "value": "hosted_confirmation" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][hosted_confirmation][custom_message]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[after_completion][redirect][return_url]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][coupon_offer][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_cancel][retention][type]", "value": "coupon_offer" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][0][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][id]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][price]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][items][1][quantity]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][subscription]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][0][promotion_code]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][coupon]", "value": "" }, { "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.", "key": "flow_data[subscription_update_confirm][discounts][1][promotion_code]", "value": "" }, { "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer\u2019s `preferred_locales` or browser\u2019s locale is used.", "key": "locale", "value": "fr-CA" }, { "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "key": "on_behalf_of", "value": "" }, { "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.", "key": "return_url", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/billing_portal/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_portal", "sessions" ] } }, "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:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-24342aa8-ac71-46d9-bd43-dff88a2b8ad6" } ], "createdAt": "2026-06-05T13:21:28.000Z", "updatedAt": "2026-06-05T13:21:28.000Z", "uid": "35240-1866062f-41ee-4aef-9ca2-e826542a684b" } ], "id": "a729c2c3-9c56-47b1-91cc-d6063444a6a5", "createdAt": "2026-06-05T13:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "uid": "35240-a729c2c3-9c56-47b1-91cc-d6063444a6a5" } ], "id": "453ad5b1-040c-4534-93ea-551af599f924", "createdAt": "2026-06-05T13:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "uid": "35240-453ad5b1-040c-4534-93ea-551af599f924" } ], "id": "7ae43ac2-d774-4f70-9ffc-592c8f4ee6a5", "createdAt": "2026-06-05T13:21:27.000Z", "updatedAt": "2026-06-05T13:21:27.000Z", "uid": "35240-7ae43ac2-d774-4f70-9ffc-592c8f4ee6a5" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.stripe.com/" } ] }