402 Payment Required

Rarely used, originally intended for digital micro-payments. Now used by some APIs (like Stripe) to indicate failed payments or exceeded quotas.

When and Why to Use It

Mostly experimental, but you can use this if a user tries to use your API but they have exhausted their prepaid credits or their subscription payment failed.

Usage Examples

Shokupan (Functional)

import { HttpException, get } from 'shokupan';

export const getResource = get('/resource', () => {
    throw new HttpException('Payment Required', 402);
});

Shokupan (Controller)

import { Controller, Get, HttpException } from 'shokupan';

@Controller('/api')
export class ExampleController {
    @Get('/resource')
    getResource() {
        throw new HttpException('Payment Required', 402);
    }
}

Express

import express from 'express';
const app = express();

app.get('/resource', (req, res) => {
    res.status(402).json({ error: 'Payment Required' });
});

Nest

import { Controller, Get, HttpException } from '@nestjs/common';

@Controller('api')
export class ExampleController {
  @Get('resource')
  getResource() {
    throw new HttpException('Payment Required', 402);
  }
}

Koa

import Koa from 'koa';
const app = new Koa();

app.use(async ctx => {
  if (ctx.path === '/resource' && ctx.method === 'GET') {
    ctx.status = 402;
    ctx.body = { error: 'Payment Required' };
  }
});