BillKit/DocsConsole
Products

Get product

Retrieve one product.

GET/v1/products/{product_id}
Operation get_product·Scope products:read·OpenAPI v1.1.0

Parameters

ParameterDescription
product_idstring · pathrequiredId of the product, which starts prod_.
expandstring | null · queryoptionalComma-separated related objects to include in the response. Expandable here: default_price, prices, stats. An unknown name is a 400, and embedding another resource needs that resource's read scope. At most 256 characters.

Returns

Returns a ProductResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the products:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/products/prod_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "active": false,
  "allow_promotion_codes": false,
  "archived_at": 1789392000,
  "created": 1789392000,
  "default_price": {
    "active": false,
    "amount_cents": 1900,
    "billing_scheme": "per_unit",
    "currency": "EUR",
    "id": "obj_9XKp2vQ1",
    "interval": "month",
    "object": "price.summary",
    "payment_methods": [
      "creditcard"
    ],
    "payment_methods_from_account": false,
    "product_id": "prod_9XKp2vQ1",
    "product_name": "Ada Lovelace",
    "tax_behavior": "inclusive",
    "tiers_mode": "graduated",
    "trial_days": 0,
    "unit_amount_decimal": "string",
    "usage_type": "licensed"
  },
  "default_price_id": "default_price_9XKp2vQ1",
  "description": "string",
  "id": "prod_9XKp2vQ1",
  "livemode": false,
  "marketing_features": [
    "string"
  ],
  "metadata": {
    "key": "value"
  },
  "name": "Ada Lovelace",
  "object": "product",
  "prices": [
    {
      "active": false,
      "amount_cents": 1900,
      "billing_scheme": "per_unit",
      "currency": "EUR",
      "id": "obj_9XKp2vQ1",
      "interval": "month",
      "object": "price.summary",
      "payment_methods": [
        "creditcard"
      ],
      "payment_methods_from_account": false,
      "product_id": "prod_9XKp2vQ1",
      "product_name": "Ada Lovelace",
      "tax_behavior": "inclusive",
      "tiers_mode": "graduated",
      "trial_days": 0,
      "unit_amount_decimal": "string",
      "usage_type": "licensed"
    }
  ],
  "stats": {
    "active_price_count": 1900,
    "currency": "EUR",
    "mrr_cents": 1900,
    "object": "product.stats",
    "subscriber_count": 0
  }
}