Get Product

GET

/api/:account_id/products/:product_id

GET

/api/:account_id/products/:product_id

$ curl https://app.paymentkit.com/api/account_id/products/product_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "prod_9f8b7c6d5e4a3b2c1d0e",
3   "account_id": "acct_1234567890abcdef",
4   "name": "Wireless Bluetooth Headphones",
5   "description": "High-quality wireless headphones with noise cancellation and 20 hours battery life.",
6   "is_active": true,
7   "default_price_id": "price_01a2b3c4d5e6f7g8h9i0",
8   "metadata": {
9     "brand": "SoundMax",
10     "color": "Matte Black",
11     "warranty": "2 years"
12   },
13   "created_at": "2024-01-15T09:30:00Z",
14   "updated_at": "2024-01-15T09:30:00Z",
15   "total_prices": 3,
16   "custom_fields": {
17     "release_year": 2023,
18     "category": "Audio"
19   }
20 }

Get a product by ID. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

product_idstringRequired

account_idstringRequired

Query parameters

include_deletedbooleanOptionalDefaults to false

Include soft-deleted products

expandlist of strings or nullOptional

Response

Successful Response

idstring

account_idstring

namestring

descriptionstring or null

is_activeboolean

default_price_idstring or null

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

total_pricesinteger

custom_fieldsmap from strings to any or nullOptional

Custom field values. Only included when expand=custom_fields is specified.

Errors

422

Unprocessable Entity Error