{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Delivery Adjustments API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Delivery Adjustments", "type": "folder" }, "items": [ { "info": { "name": "List all delivery adjustments of a subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/adjustments", "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": "subscription-number", "value": "", "type": "query", "description": "A subscription number.\n" } ] }, "docs": "Describes how to retrieve detailed information about delivery adjustments of a subscription.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in " }, { "info": { "name": "Create a delivery adjustment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/adjustments", "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": "Describes how to create one or more delivery adjustments for a subscription. \n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowled" }, { "info": { "name": "Retrieve a delivery adjustment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/adjustments/:adjustment-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": "adjustment-key", "value": "", "type": "path", "description": "The delivery adjustment ID or number to retrieve." } ] }, "docs": "Describes how to retrieve detailed information about a delivery adjustment.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Cen" }, { "info": { "name": "Preview a delivery adjustment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/adjustments/preview", "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": "Describes how to preview delivery adjustments of a subscription.\n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n- " }, { "info": { "name": "Cancel a delivery adjustment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/adjustments/:adjustmentId/cancel", "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": "adjustmentId", "value": "", "type": "path", "description": "The ID of the delivery adjustment to cancel.\n" } ] }, "docs": "Describes how to cancel an unbilled delivery adjustment.\n\n**Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n" } ] } ], "bundled": true }