COcounselhealth
/v1/user

Create a Stripe billing portal session for a user

Mints a short-lived (~5 min) Stripe-hosted billing portal URL the user can visit to manage their subscription (update payment method, view invoices, cancel). The session is bound to the user's Stripe customer and uses the appropriate billing portal configuration for their organization and plan. After the user finishes, Stripe redirects them to the supplied return_url

post/v1/user/{userId}/subscriptions/billingPortalSession/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Request body

return_urlstring uri required

Response

Default Response

urlstring uri required
expires_atstring date-time required

datetime in ISO 8601 format

Example response

{
  "expires_at": "2030-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.