customer-portals

Create a customer portal session (deprecated)

Deprecated — the customer portal is being retired, and this endpoint will be removed in a future release. It keeps working for existing integrations meanwhile: it creates a portal session for the customer and returns a short-lived URL to the customer portal. Contact Paid before building anything new on it.

post/customer-portals/

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customer-portals/
  • Auth: HTTP bearer

Request body

customerIdstring

The Paid customer ID (display ID or UUID). Either this or externalCustomerId must be provided.

externalCustomerIdstring

Your external customer ID. Either this or customerId must be provided.

returnUrlstring uri
expiresAtstring date-time

Response

201

idstring required
customerIdstring required
urlstring required
status'active' | 'expired' required
returnUrlstring nullable required
expiresAtstring date-time required
createdAtstring date-time required

Changes

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