OpenMeter Customers

Create Stripe customer portal session

Create Stripe Customer Portal Session.

Useful to redirect the customer to the Stripe Customer Portal to manage their payment methods, change their billing address and access their invoice history. Only returns URL if the customer billing profile is linked to a stripe app and customer.

post/openmeter/customers/{customerId}/billing/stripe/portal-sessions

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}/billing/stripe/portal-sessions
  • Auth: none declared

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

Response

CreateStripeCustomerPortalSessionResult created response.

idstring required

The ID of the customer portal session.

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

stripe_customer_idstring required

The ID of the stripe customer.

configuration_idstring required

Configuration used to customize the customer portal.

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

livemodeboolean required

Livemode.

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

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

return_urlstring required

Return URL.

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

localestring required

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

urlstring required

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

Example response

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

Changes

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