BillKit/DocsConsole
Products

List products

List your products, newest first.

GET/v1/products
Operation list_products·Scope products:read·OpenAPI v1.1.0

Parameters

ParameterDescription
limitinteger · queryoptionalMaximum number of objects to return. Defaults to 10. Between 1 and 100.
starting_afterstring | null · queryoptionalCursor for pagination: the id of the last object on the previous page. Returns the objects listed after it. An id that names no such object is a 400. At most 128 characters.
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.

Cursor-paginated. limit caps a page and starting_after takes the last id you saw.

Returns

Returns a page of ProductResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.

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 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "data": [
    {
      "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": [],
        "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": null,
          "amount_cents": null,
          "billing_scheme": null,
          "currency": null,
          "id": null,
          "interval": null,
          "object": null,
          "payment_methods": null,
          "payment_methods_from_account": null,
          "product_id": null,
          "product_name": null,
          "tax_behavior": null,
          "tiers_mode": null,
          "trial_days": null,
          "unit_amount_decimal": null,
          "usage_type": null
        }
      ],
      "stats": {
        "active_price_count": 1900,
        "currency": "EUR",
        "mrr_cents": 1900,
        "object": "product.stats",
        "subscriber_count": 0
      }
    }
  ],
  "has_more": false,
  "object": "list"
}