Open Customer Portal

POST /customers/{customer_id}/billing_portal

TypeScript

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.customers.billingPortal('customer_id');

200

{
  "customer_id": "<string>",
  "url": "<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

Body

application/json

return_url · string

URL to redirect to when back button is clicked in the billing portal.

Response

200 - application/json

customer_id · string · required

The ID of the customer

url · string · required

URL to the billing portal