Class default

Transactions client — billing/subscriptions, invoices, credits/balance, usage pricing and per-project billing-mode overrides. All routes go through the transactions/… gateway prefix (/luma/transactions/v1/...), matching the transactions service's REST surface (internal/controllers/{subscription,invoices,topup,credit_history,billing_modes,prices,balance}.go).

This is the billing service — not distributed/database transactions.

Hierarchy (View Summary)

default
- default

Index

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/platformBaseClient.ts:24

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

cancelSubscription

cancelSubscription(
payload: CancelSubscriptionPayload,
): Promise<AxiosResponse<CancelSubscriptionResult, any>>
Cancel a subscription. Issues a refund automatically if still within the refund period.
Parameters
- payload: CancelSubscriptionPayload
Returns Promise<AxiosResponse<CancelSubscriptionResult, any>>
- Defined in v0.10/api/transactions.ts:64

getBalance

getBalance(): Promise<AxiosResponse<BalanceResult, any>>
Get the current project's credit balance.

Returns Promise<AxiosResponse<BalanceResult, any>>
- Defined in v0.10/api/transactions.ts:112

getBillingModes

getBillingModes(): Promise<AxiosResponse<GetBillingModesResult, any>>
Get the project's usage-billing-mode overrides plus platform defaults.

Returns Promise<AxiosResponse<GetBillingModesResult, any>>
- Defined in v0.10/api/transactions.ts:154

getCreditsHistory

getCreditsHistory(
query?: CreditsHistoryQuery,
): Promise<AxiosResponse<CreditsHistoryResult, any>>
Get the project's credit activity (deductions/top-ups) history, paginated.
Parameters
- Optionalquery: CreditsHistoryQuery
Returns Promise<AxiosResponse<CreditsHistoryResult, any>>
- Defined in v0.10/api/transactions.ts:126

getInvoice

getInvoice(uuid: string): Promise<AxiosResponse<Invoice, any>>
Get a single invoice by uuid.
Parameters
- uuid: string
Returns Promise<AxiosResponse<Invoice, any>>
- Defined in v0.10/api/transactions.ts:87

getInvoicePdf

getInvoicePdf(uuid: string): Promise<AxiosResponse<ArrayBuffer, any>>
Download an invoice as a PDF. Resolves with the raw PDF bytes (responseType: "arraybuffer").
Parameters
- uuid: string
Returns Promise<AxiosResponse<ArrayBuffer, any>>
Example
```
const { data } = await platform.transactions().getInvoicePdf(uuid)
fs.writeFileSync("invoice.pdf", Buffer.from(data))
```
- Defined in v0.10/api/transactions.ts:99

getInvoices

getInvoices(): Promise<AxiosResponse<Invoice[], any>>
List all invoices for the current project.

Returns Promise<AxiosResponse<Invoice[], any>>
- Defined in v0.10/api/transactions.ts:80

getPrices

getPrices(currency: string): Promise<AxiosResponse<SubscriptionPrices, any>>
Get the usage-based pricing table for a given currency.
Parameters
- currency: string
  ISO 4217 currency code, e.g. "USD" or "RSD".
Returns Promise<AxiosResponse<SubscriptionPrices, any>>
- Defined in v0.10/api/transactions.ts:143

getSubscriptions

getSubscriptions(): Promise<AxiosResponse<Subscription[], any>>
List all subscriptions (including expired) for the current project.

Returns Promise<AxiosResponse<Subscription[], any>>
Example
```
const subs = await platform.transactions().getSubscriptions()
```
- Defined in v0.10/api/transactions.ts:43

renewSubscription

renewSubscription(
payload: RenewSubscriptionPayload,
): Promise<AxiosResponse<RenewSubscriptionResult, any>>
Renew an expired subscription (and any others sharing its bundle ref_no) — creates a renewal invoice and returns a checkout link.
Parameters
- payload: RenewSubscriptionPayload
Returns Promise<AxiosResponse<RenewSubscriptionResult, any>>
- Defined in v0.10/api/transactions.ts:51

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

topUp

topUp(payload: TopUpPayload): Promise<AxiosResponse<TopUpResult, any>>
Generate a checkout link to manually top up the project's credit balance.
Parameters
- payload: TopUpPayload
Returns Promise<AxiosResponse<TopUpResult, any>>
- Defined in v0.10/api/transactions.ts:119

updateBillingModes

updateBillingModes(
payload: UpdateBillingModePayload,
): Promise<AxiosResponse<UpdateBillingModeResult, any>>
Set the billing mode ("credits" | "hybrid" | "invoice") for a usage option code on the current project.
Parameters
- payload: UpdateBillingModePayload
Returns Promise<AxiosResponse<UpdateBillingModeResult, any>>
- Defined in v0.10/api/transactions.ts:162

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

cancelSubscription

Parameters

Returns Promise<AxiosResponse<CancelSubscriptionResult, any>>

getBalance

Returns Promise<AxiosResponse<BalanceResult, any>>

getBillingModes

Returns Promise<AxiosResponse<GetBillingModesResult, any>>

getCreditsHistory

Parameters

Returns Promise<AxiosResponse<CreditsHistoryResult, any>>

getInvoice

Parameters

Returns Promise<AxiosResponse<Invoice, any>>

getInvoicePdf

Parameters

Returns Promise<AxiosResponse<ArrayBuffer, any>>

Example

getInvoices

Returns Promise<AxiosResponse<Invoice[], any>>

getPrices

Parameters

Returns Promise<AxiosResponse<SubscriptionPrices, any>>

getSubscriptions

Returns Promise<AxiosResponse<Subscription[], any>>

Example

renewSubscription

Parameters

Returns Promise<AxiosResponse<RenewSubscriptionResult, any>>

setClient

Parameters

Returns default

topUp

Parameters

Returns Promise<AxiosResponse<TopUpResult, any>>

updateBillingModes

Parameters

Returns Promise<AxiosResponse<UpdateBillingModeResult, any>>

Settings

On This Page

`Protected`env

`Protected`host

`Protected`token