BitGPT 402pay Documentation

{
  "id": "<string>",
  "organization_id": "<string>",
  "status": "PENDING",
  "currency": "BITCOIN",
  "price": "<string>",
  "created_at": "<string>",
  "updated_at": "2025-07-04 18:10:53",
  "customer_email": "[email protected]",
  "substatus": "OVERPAID",
  "price_usd": "<string>",
  "metadata": {},
  "redirect_url": "https://example.com/success",
  "items": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "invoice_id": "<string>",
      "type": "PAYMENT_INTENT",
      "currency": "BITCOIN",
      "product_id": "<string>",
      "billing_schema_id": "<string>",
      "payment_intent_id": "<string>",
      "quantity": 123,
      "status": "INCLUDED",
      "exclude_reason": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "product": {
        "id": "<string>",
        "name": "<string>",
        "organization_id": "<string>",
        "version_group_id": "<string>",
        "is_active": 123,
        "description": "Premium API access with advanced features",
        "image_id": "img_0197a8d9-8426-7e71-9edf-26301686ed26",
        "metadata": {},
        "schemas": [
          {
            "id": "<string>",
            "version_group_id": "<string>",
            "is_active": 123,
            "name": "<string>",
            "description": "Basic Product Schema",
            "organization_id": "<string>",
            "product_id": "<string>",
            "type": "ONE_TIME",
            "currency": "BITCOIN",
            "base_price": "<string>",
            "interval_type": "DAY",
            "interval_count": 123,
            "payment_type": "ADVANCE",
            "renew_type": "CALENDAR",
            "billing_type": "PRORATED",
            "created_at": "<string>",
            "updated_at": "2024-01-15 10:30:00",
            "configurations": [
              {
                "id": "<string>",
                "version_group_id": "<string>",
                "is_active": 123,
                "schema_id": "<string>",
                "starts_at": "<string>",
                "ends_at": "<string>",
                "price_per_unit": "<string>",
                "metric_id": "<string>",
                "created_at": "<string>",
                "updated_at": "2024-01-15 10:30:00"
              }
            ]
          }
        ],
        "created_at": "<string>",
        "updated_at": "2024-01-15 10:30:00",
        "image": {
          "id": "file_0196b6e6-54e3-796d-9c6a-2862a5fef597",
          "url": "https://assets.bitgpt.xyz//app/public/src/storage/uploads/image/2025/05/09/0196b6e6-54e3-7290-9d73-0074c623e368.jpg"
        }
      },
      "billing_schema": {
        "id": "<string>",
        "version_group_id": "<string>",
        "is_active": 123,
        "name": "<string>",
        "description": "Basic Product Schema",
        "organization_id": "<string>",
        "product_id": "<string>",
        "type": "ONE_TIME",
        "currency": "BITCOIN",
        "base_price": "<string>",
        "interval_type": "DAY",
        "interval_count": 123,
        "payment_type": "ADVANCE",
        "renew_type": "CALENDAR",
        "billing_type": "PRORATED",
        "created_at": "<string>",
        "updated_at": "2024-01-15 10:30:00",
        "configurations": [
          {
            "id": "<string>",
            "version_group_id": "<string>",
            "is_active": 123,
            "schema_id": "<string>",
            "starts_at": "<string>",
            "ends_at": "<string>",
            "price_per_unit": "<string>",
            "metric_id": "<string>",
            "created_at": "<string>",
            "updated_at": "2024-01-15 10:30:00"
          }
        ]
      },
      "payment_intent": {
        "id": "<string>",
        "organization_id": "<string>",
        "currency": "BITCOIN",
        "price": "<string>",
        "created_at": "<string>",
        "customer_email": "<string>",
        "updated_at": "2025-07-04 18:10:53"
      }
    }
  ],
  "calculations": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "invoice_id": "<string>",
      "invoice_item_id": "<string>",
      "title": "<string>",
      "calculation_type": "CURRENCY_CHANGE",
      "idx": 123,
      "currency": "BITCOIN",
      "initial_price": "<string>",
      "price_delta": "<string>",
      "price": "<string>",
      "details": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "calculation_summary": {
    "invoice_id": "<string>",
    "currency": "BITCOIN",
    "currency_original": "GBP",
    "total_price": "<string>",
    "total_price_usd": "<string>",
    "total_price_original": "<string>",
    "cache": {
      "used": true,
      "expires_at": 123,
      "expires_in": 123
    },
    "convert_currency": "BITCOIN",
    "total_price_converted": "<string>"
  },
  "organization": {
    "name": "<string>",
    "image_url": "<string>",
    "stripe_config": {
      "stripe_user_id": "<string>"
    }
  },
  "payments": [
    {
      "id": "<string>",
      "idempotency_key": "<string>",
      "organization_id": "<string>",
      "provider_id": "<string>",
      "invoice_id": "<string>",
      "currency": "<string>",
      "price": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "happened_at": "<string>"
    }
  ]
}

Invoice object containing billing information, invoice items, calculations, and organization details for payment processing

string

required

Unique identifier for the invoice

Example:

"invoice_0197d634-7d8e-7615-8007-e37b992cdb30"

organization_id

string

required

Unique identifier for the organization

Example:

"org_0196b0e9-11d8-7f26-b1d2-bd47054e4827"

status

enum<string>

required

Current status of the invoice

Available options:

PENDING,

COMPLETED,

VOIDED,

PROCESSING,

WAITING_FOR_CONFIRMATIONS,

PARTIALLY_PAID

Example:

"PENDING"

currency

enum<string>

required

Currency code for the invoice

Available options:

BITCOIN,

ETHEREUM,

USDT,

USDC,

USDC_NATIVE,

SOLANA,

BINANCE_COIN,

RIPPLE,

POLYGON,

TRON,

LITECOIN,

BITCOIN_CASH,

DOGECOIN,

USD,

EUR,

CHF,

GBP,

AUD,

JPY,

CNY,

CAD,

HKD,

SGD,

SEK,

KRW,

NOK,

NZD,

INR,

MXN,

TWD,

ZAR,

BRL,

DKK,

PLN,

THB,

ILS,

IDR,

CZK,

AED,

TRY,

HUF,

CLP,

SAR,

PHP,

MYR,

COP,

RUB,

RON,

PEN

Example:

"EUR"

price

string

required

Total price of the invoice as a decimal string

Example:

"504.818257074815000000000000000000"

created_at

string<mysql-date-time>

required

Timestamp when the invoice was created

Example:

"2025-07-04 18:10:53"

updated_at

string<mysql-date-time> | null

required

Timestamp when the invoice was last updated

Example:

"2025-07-04 18:10:53"

customer_email

string<email>

Customer email address for the invoice

Example:

"[email protected]"

substatus

enum<string> | null

Provides additional context to the invoice's current status

Available options:

OVERPAID

Example:

"OVERPAID"

price_usd

string

Total price of the invoice in USD as a decimal string

Example:

"504.818257074815000000000000000000"

metadata

object

Additional metadata for the invoice

redirect_url

string<uri> | null

URL to redirect to after payment completion

Example:

"https://example.com/success"

items

object[]

Array of invoice items

Show child attributes

calculations

object[]

Array of invoice calculations

Show child attributes

calculation_summary

object

Summary of invoice calculations

Show child attributes

organization

object

Organization information

Show child attributes

payments

object[]

Array of payments

Show child attributes

Provider File

⌘I

GET STARTED

WEBHOOKS

API REFERENCE

Invoice