{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Product Rate Plans API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Product Rate Plans", "type": "folder" }, "items": [ { "info": { "name": "List all product rate plans of a product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/products/:product-key/product-rate-plans", "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": "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": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "product-key", "value": "", "type": "path", "description": "The unique ID or SKU of a product. For example, 2c92c0f96487e16a016487f663c71a61 or SKU-00000987.\n" }, { "name": "show-charge-definitions", "value": "", "type": "query", "description": "Specifies whether to include the product charge definitions of this rate plan in the response.\n\n**Note**: This parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at Zuora Global Support.\n" } ] }, "docs": "Retrieves information about all product rate plans of a specific product.\n" }, { "info": { "name": "Retrieve a product rate plan by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rate-plans/:id", "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": "id", "value": "", "type": "path", "description": "The ID, external ID, or the natural key of the product rate plan to be retrieved. For example, `402888e67f8b3a68017f8bbb2a06062d`, `Apple0001`, or `PRP-00000008`.\n" } ] }, "docs": "Retrieves a product rate plan by its ID.\n" }, { "info": { "name": "List product rate plans by external ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/product-rate-plans/external-id/:id", "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": "id", "value": "", "type": "path", "description": "The external ID of the product rate plan to be retrieved. For example, `Apple0001`.\n" } ] }, "docs": "Retrieves information about one or multiple product rate plans by external ID.\n" }, { "info": { "name": "CRUD: Create a product rate plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/object/product-rate-plan", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Retrieves a product rate plan.\n" }, { "info": { "name": "CRUD: Retrieve a product rate plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Object fields to return" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Retrieves a product rate plan.\n" }, { "info": { "name": "CRUD: Update a product rate plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" }, { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Updates a product rate plan.\n" }, { "info": { "name": "CRUD: Delete a product rate plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/object/product-rate-plan/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Object id" } ] }, "docs": "Deletes a product rate plan.\n" } ] } ], "bundled": true }