Create Customer Portal Session

Create a session of the Customer Portal for a specific customer.

POST /customers/{customer_id}/customer-portal/session

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const customerPortalSession = await client.customers.customerPortal.create('customer_id');

console.log(customerPortalSession.link);

200

{
  "link": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id · string · required

Customer Id

Query Parameters

send_email · boolean

If true, will send link to user.

return_url · string

Optional return URL for this session. Overrides the business-level default. This URL will be shown as a "Return to {business}" back button in the portal.

Response

200

application/json

Successfully send email to customer (if they exist)

link · string · required