Skip to main content
GET
/
products
/
{id}
Get a product
curl --request GET \
  --url https://api.bitgpt.xyz/products/{id} \
  --header 'Authorization: <api-key>'
{
  "status": 200,
  "data": {
    "id": "product_0197a8d9-8426-7e71-9edf-26301686ed26",
    "version_group_id": "vg_0197a8d9-8426-7e71-9edf-26301686ed26",
    "is_active": 1,
    "name": "Premium API Access",
    "organization_id": "org_0197a8d9-8426-7e71-9edf-26301686ed26",
    "description": "Premium API access with advanced features",
    "image_id": "img_0197a8d9-8426-7e71-9edf-26301686ed26",
    "metadata": {
      "category": "api",
      "tier": "premium"
    },
    "schemas": [
      {
        "id": "schema_0197a8d9-8426-7e71-9edf-26301686ed26",
        "version_group_id": "schema_0197a8d9-8426-7e71-9edf-26301686ed26",
        "is_active": 1,
        "name": "Basic Product",
        "description": "Basic Product Schema",
        "organization_id": "org_0197a8d9-8426-7e71-9edf-26301686ed26",
        "product_id": "product_0197a8d9-8426-7e71-9edf-26301686ed26",
        "type": "RECURRING",
        "currency": "USD",
        "base_price": "10.030000000000000000000000000000",
        "interval_type": "MONTH",
        "interval_count": 1,
        "payment_type": "ARREARS",
        "renew_type": "CALENDAR",
        "billing_type": "FULL",
        "created_at": "2024-01-15 10:30:00",
        "updated_at": "2024-01-15 10:30:00",
        "configurations": [
          {
            "id": "config_0197a8d9-8426-7e71-9edf-26301686ed26",
            "version_group_id": "config_0197a8d9-8426-7e71-9edf-26301686ed26",
            "is_active": 1,
            "schema_id": "schema_0197a8d9-8426-7e71-9edf-26301686ed26",
            "starts_at": "1.000000000000",
            "ends_at": "2.000000000000",
            "price_per_unit": "5.000000000000000000000000000000",
            "metric_id": "metric_0197a8d9-8426-7e71-9edf-26301686ed26",
            "created_at": "2024-01-15 10:30:00",
            "updated_at": "2024-01-15 10:30:00"
          }
        ]
      }
    ],
    "created_at": "2024-01-15 10:30:00",
    "updated_at": "2024-01-15 10:30:00"
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

Authorizations

​
Authorization
string
header
required

Send your access token as header Authorization: Bearer {accessToken}

​
Authorization
string
header
required

Your API key that starts with sk_live or sk_test. You can create yours at go.bitgpt.xyz/api-keys.

Path Parameters

​
id
string
required

Product ID

Response

Product retrieved successfully

Response for successful product retrieval

​
status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
​
data
object
required

Product entity

Example:
{
  "id": "product_01971675-8d84-79cb-8daa-304ca034b067",
  "version_group_id": "product_01971675-8d84-79cb-8daa-304ca034b067",
  "is_active": 1,
  "name": "First Subscription #1",
  "organization_id": "org_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
  "description": "Third Subscriptio is coming",
  "image_id": null,
  "metadata": {
    "one": "1",
    "two": "2",
    "three": "3",
    "four": "4"
  },
  "created_at": "2025-05-28 12:34:52",
  "updated_at": "2025-06-22 19:12:41",
  "schemas": [
    {
      "id": "schema_01971675-8d85-7007-bc44-dc2a77e1038d",
      "version_group_id": "schema_01971675-8d85-7007-bc44-dc2a77e1038d",
      "is_active": 1,
      "name": "Basic Product",
      "description": "Basic Product Schema",
      "organization_id": "org_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
      "product_id": "product_01971675-8d84-79cb-8daa-304ca034b067",
      "type": "RECURRING",
      "currency": "USD",
      "base_price": "10.030000000000000000000000000000",
      "interval_type": "MONTH",
      "interval_count": 1,
      "payment_type": "ARREARS",
      "renew_type": "CALENDAR",
      "billing_type": "FULL",
      "created_at": "2025-05-28 12:34:52",
      "updated_at": "2025-06-22 19:12:41",
      "configurations": [
        {
          "id": "config_01971675-8d86-72bb-9f08-82e2456c6e26",
          "version_group_id": "config_01971675-8d86-72bb-9f08-82e2456c6e26",
          "is_active": 1,
          "schema_id": "schema_01971675-8d85-7007-bc44-dc2a77e1038d",
          "starts_at": "1.000000000000",
          "ends_at": "2.000000000000",
          "price_per_unit": "5.000000000000000000000000000000",
          "metric_id": "metric_01971675-8d86-797c-8621-b918d4c83fc1",
          "created_at": "2025-05-28 12:34:52",
          "updated_at": "2025-06-22 19:12:41"
        },
        {
          "id": "config_01971675-8d86-72bb-9f08-82e2456c6e27",
          "version_group_id": "config_01971675-8d86-72bb-9f08-82e2456c6e27",
          "is_active": 1,
          "schema_id": "schema_01971675-8d85-7007-bc44-dc2a77e1038d",
          "starts_at": "2.000000000000",
          "ends_at": "3.000000000000",
          "price_per_unit": "6.000000000000000000000000000000",
          "metric_id": "metric_01971675-8d86-797c-8621-b918d4c83fc1",
          "created_at": "2025-06-12 23:57:41",
          "updated_at": "2025-06-22 19:12:41"
        }
      ]
    },
    {
      "id": "schema_01971675-8d85-7007-bc44-dc2a77e1038e",
      "version_group_id": "schema_01971675-8d85-7007-bc44-dc2a77e1038e",
      "is_active": 1,
      "name": "Middle Products",
      "description": "Middle Product Schema",
      "organization_id": "org_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
      "product_id": "product_01971675-8d84-79cb-8daa-304ca034b067",
      "type": "RECURRING",
      "currency": "USD",
      "base_price": "15.000000000000000000000000000000",
      "interval_type": "MONTH",
      "interval_count": 1,
      "payment_type": "ARREARS",
      "renew_type": "CALENDAR",
      "billing_type": "FULL",
      "created_at": "2025-06-12 23:47:20",
      "updated_at": "2025-06-22 19:12:41",
      "configurations": []
    }
  ]
}
​
message
string | null
required

Message of the response, human readable

Example:

"Resource created successfully"

​
env
enum<string>
required

API environment

Available options:
development,
production
​
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

​
log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

​
validator
object

Validator response object, each key is the field name and value is the error message

Example:
{
  "email": "Invalid email address",
  "password": "Password is required"
}
​
support_id
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"