Open Customer Portal

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

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

{
  "customer_id": "<string>",
  "url": "<string>"
}

POST

customers

{customer_id}

billing_portal

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

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

{
  "customer_id": "<string>",
  "url": "<string>"
}

Authorization

string

header

required

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

customer_id

string

required

application/json

return_url

string

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

200 - application/json

customer_id

string

required

The ID of the customer

url

string

required

URL to the billing portal

⌘I