{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Price Book Items API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Price Book Items", "type": "folder" }, "items": [ { "info": { "name": "List price book items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/price-book-items", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "offer", "value": "", "type": "query", "description": "Used if you want to filter the PBIs associated with one offer. Can be offer id or number\n" }, { "name": "charge", "value": "", "type": "query", "description": "Used if you want to filter the PBIs of a charge. Charge id for now.\n" } ] }, "docs": "Retrieves basic information about all price book items.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Create a price book item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/price-book-items", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a price book item.\n\n**Note**: This operation is in the **Beta** phase. \n" }, { "info": { "name": "Retrieve a price book item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be retrieved.\n" } ] }, "docs": "Retrieves basic information about a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Update a price book item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be updated.\n" } ] }, "docs": "Update a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" }, { "info": { "name": "Delete a price book item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/price-book-items/:price-book-item-key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "price-book-item-key", "value": "", "type": "path", "description": "The unique number or ID of the price book item to be deleted.\n" } ] }, "docs": "Deletes a price book item.\n\n**Note**: This operation is in the **Beta** phase.\n" } ] } ], "bundled": true }