Skip to main content
POST
/
customers
/
{customer_id}
/
billing_portal
TypeScript
import { Autumn as autumn } from 'autumn-js';

const response = await autumn.customers.billingPortal('user_123', {
  return_url: 'https://example.com/account'
});
{
  "url": "https://billing.stripe.com/session/<hash>"
}

Authorizations

​
Authorization
string
header
required

Use your Autumn Secret Key as the Bearer token.

Path Parameters

​
customer_id
string
required

ID which you provided when creating the customer

Body

application/json
​
return_url
string

URL to return to after the customer is finished in the billing portal

Response

200 - application/json
​
url
string

URL to access the customer's billing portal

⌘I