Class SubscriptionError

Thrown for HTTP 402 responses when the current subscription does not permit the requested API operation.

Hierarchy (View Summary)

BugBugError
- SubscriptionError

Index

Constructors

constructor

new SubscriptionError(
    message?: string,
    response?: Response,
    request?: RequestOrigin,
    upgradeUrl?: string,
): SubscriptionError
Parameters
- message: string = 'This operation is not available on your current plan. Upgrade your plan to continue.'
- Optionalresponse: Response
- Optionalrequest: RequestOrigin
- OptionalupgradeUrl: string
Returns SubscriptionError
Overrides BugBugError.constructor
- Defined in sdk/src/types/errors.ts:119

Properties

`Readonly`code

code: SdkErrorCode

`Readonly`statusCode

statusCode: number

`Optional` `Readonly`response

response?: Response

`Optional` `Readonly`request

request?: RequestOrigin

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`upgradeUrl

upgradeUrl?: string

Methods

toJSON

toJSON(): {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin
    | undefined;
    stack: string | undefined;
}
Returns {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin | undefined;
    stack: string | undefined;
}
Inherited from BugBugError.toJSON
- Defined in sdk/src/types/errors.ts:68

Class SubscriptionError

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SubscriptionError

Properties

`Readonly`code

`Readonly`statusCode

`Optional` `Readonly`response

`Optional` `Readonly`request

`Optional` `Readonly`cause

`Optional` `Readonly`upgradeUrl

Methods

toJSON

Returns {
    name: string;
    code: SdkErrorCode;
    message: string;
    statusCode: number;
    request: RequestOrigin | undefined;
    stack: string | undefined;
}

Settings

On This Page

Class SubscriptionError

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SubscriptionError

Properties

Readonlycode

ReadonlystatusCode

Optional Readonlyresponse

Optional Readonlyrequest

Optional Readonlycause

Optional ReadonlyupgradeUrl

Methods

toJSON

Returns { name: string; code: SdkErrorCode; message: string; statusCode: number; request: RequestOrigin | undefined; stack: string | undefined;}

Settings

On This Page

`Readonly`code

`Readonly`statusCode

`Optional` `Readonly`response

`Optional` `Readonly`request

`Optional` `Readonly`cause

`Optional` `Readonly`upgradeUrl

Returns {
name: string;
code: SdkErrorCode;
message: string;
statusCode: number;
request: RequestOrigin | undefined;
stack: string | undefined;
}