Update Product | PaymentKit

Authentication

AuthorizationBearer

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

Path parameters

product_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

namestringRequired

is_activebooleanOptionalDefaults to true

descriptionstring or nullOptional

default_price_idstring or nullOptional

metadatamap from strings to any or nullOptional

custom_fieldsmap from strings to any or nullOptional

Custom field values to set on this product. Keys must match defined field keys for the product entity type. Set a key to null to delete that field's value.

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

custom_fieldsmap from strings to any or null

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

1	from payment_kit import PaymentKit
2
3	client = PaymentKit(
4	token="YOUR_TOKEN_HERE",
5	)
6
7	client.products.update_product(
8	product_id="product_id",
9	account_id="account_id",
10	name="Premium Coffee Beans",
11	)

1	{
2	"id": "prod_9876543210",
3	"account_id": "acct_1234567890",
4	"name": "Premium Coffee Beans",
5	"description": "A selection of the finest Arabica coffee beans sourced from Colombia.",
6	"is_active": true,
7	"default_price_id": "price_123abc456def",
8	"metadata": {},
9	"created_at": "2024-01-15T09:30:00Z",
10	"updated_at": "2024-01-15T09:30:00Z",
11	"custom_fields": {}
12	}

Authentication

Path parameters

Request

Response

Errors