Class Plans

Recurring billing plans — the reusable templates subscriptions are created from (scope: subscriptions:*).

Index

Constructors

Methods

Constructors

constructor

new Plans(c: Requester): Plans
Parameters
- c: Requester
Returns Plans
- Defined in src/resources/subscriptions.ts:34

Methods

create

create(
params: CreatePlanParams,
opts?: IdempotencyOptions,
): Promise<Record<string, unknown>>
Create a recurring billing plan (scope: subscriptions:write).
Parameters
- params: CreatePlanParams
  The plan definition; see CreatePlanParams.
- opts: IdempotencyOptions = {}
  Optional { idempotencyKey } — retrying with the same key + body replays the original.
Returns Promise<Record<string, unknown>>
The created plan record.

Throws
On failure (e.g. 401/403 missing subscriptions:write, 409 duplicate merchantPlanNo).
- Defined in src/resources/subscriptions.ts:52

list

list(): Promise<Page<Record<string, unknown>>>
List all subscription plans (scope: subscriptions:read).

Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } (nextCursor always null) of plan records.

Throws
On failure (e.g. 401/403 missing subscriptions:read).
- Defined in src/resources/subscriptions.ts:41