v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Product Book

Update a product book

Updates the specified product book by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch/v2/product_book/{unique_identifier}

Path parameters

unique_identifierstring required

Unique identifier of product book. Can be the internal PartnerStack key (e.g. pbook_abc123) or the external product key (e.g. Stripe/Chargebee product ID).

Request body

descriptionstring nullable

Description of the product book

namestring

The name of the product book

Response

Updates the specified product book by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

messagestring required
statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399
  }
}