Class Subscriptions

constructor

• new Subscriptions(c: Requester): Subscriptions

  Parameters

  • c: Requester

  Returns Subscriptions

Readonlyplans

cancel

• cancel(merchantSubNo: string): Promise<Record<string, unknown>>

  Cancel a subscription so no further cycles are charged (scope: subscriptions:write).

  Parameters

  • merchantSubNo: string

    The subscription reference (merchantSubNo).

  Returns Promise<Record<string, unknown>>

  The updated subscription record.

  Throws

  On failure (e.g. 404 unknown subscription, 409 already canceled).

create

• create(
      params: CreateSubscriptionParams,
      opts?: IdempotencyOptions,
  ): Promise<Record<string, unknown>>

  Subscribe a customer to a plan (scope: subscriptions:write).

  Parameters

  • params: CreateSubscriptionParams

    The subscription to create; see CreateSubscriptionParams.

  • opts: IdempotencyOptions = {}

    Optional { idempotencyKey } — retrying with the same key + body replays the original.

  Returns Promise<Record<string, unknown>>

  The created subscription record.

  Throws

  On failure (e.g. 401/403 auth, 404 unknown plan, 409 duplicate merchantSubNo).

deductions

• deductions(merchantSubNo: string): Promise<Page<Record<string, unknown>>>

  Fetch the per-cycle deduction (charge) history for a subscription (scope: subscriptions:read).

  Parameters

  • merchantSubNo: string

    The subscription reference (merchantSubNo).

  Returns Promise<Page<Record<string, unknown>>>

  The raw { items, nextCursor } (nextCursor always null) of deduction records.

  Throws

  On failure (e.g. 404 unknown subscription).

list

• list(
      query?: PageQuery & { status?: string },
  ): Promise<Page<Record<string, unknown>>>

  List subscriptions (scope: subscriptions:read). Keyset-paginated.

  Parameters

  • query: PageQuery & { status?: string } = {}

    Filters + pagination; pass a prior page's nextCursor as before.

    • Optionalstatus?: string

      Optional status filter (e.g. "active", "canceled").

  Returns Promise<Page<Record<string, unknown>>>

  The raw { items, nextCursor } page of subscription records.

  Throws

  On failure (e.g. 401/403 missing subscriptions:read).