libs/billing-api-client/src/docs/PortalUrlApi.md
All URIs are relative to http://localhost:6100
| Method | HTTP request | Description |
|---|---|---|
| getPortalUrl | GET /organization/{organizationId}/portal-url | Get organization billing portal url |
| getV2PortalURL | GET /v2/organization/{organizationId}/portal-url | Get organization billing portal url |
string getPortalUrl()
Get organization billing portal url
import {
PortalUrlApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new PortalUrlApi(configuration);
let organizationId: string; //Organization ID (default to undefined)
const { status, data } = await apiInstance.getPortalUrl(
organizationId
);
| Name | Type | Description | Notes |
|---|---|---|---|
| organizationId | [string] | Organization ID | defaults to undefined |
string
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string getV2PortalURL()
Get organization billing portal url from v2 billing
import {
PortalUrlApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new PortalUrlApi(configuration);
let organizationId: string; //Organization ID (default to undefined)
const { status, data } = await apiInstance.getV2PortalURL(
organizationId
);
| Name | Type | Description | Notes |
|---|---|---|---|
| organizationId | [string] | Organization ID | defaults to undefined |
string
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]