OPopenmeter
Customers

Create Stripe customer portal session

Create Stripe customer portal session. Only returns URL if the customer billing profile is linked to a stripe app and customer.

Useful to redirect the customer to the Stripe customer portal to manage their payment methods, change their billing address and access their invoice history.

post/api/v1/customers/{customerIdOrKey}/stripe/portal

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

configurationIdstring

The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.

See https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-configuration

localestring

The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

See: https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale

returnUrlstring

The URL to redirect the customer to after they have completed their requested actions.

See: https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url

Response

The request has succeeded and a new resource has been created as a result.

configurationIdstring required

Configuration used to customize the customer portal.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration

createdAtstring date-time required

Created at.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created

idstring required

The ID of the customer portal session.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id

livemodeboolean required

Livemode.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode

localestring required

Status. /** The IETF language tag of the locale customer portal is displayed in.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale

returnUrlstring required

Return URL.

See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url

stripeCustomerIdstring required

The ID of the stripe customer.

urlstring required

/** The ID of the customer.The URL to redirect the customer to after they have completed their requested actions.

Example response

{
  "createdAt": "2023-01-01T01:01:01.001Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.