### Example Remove Product Charge Updates

Source: https://developer.zuora.com/v1-api-reference/api/orders/post_order

Provides an example of how to structure the charge updates when removing a product. This includes details like charge number, product rate plan charge ID, and unique token.

```json
[
  {
    "chargeNumber": "chargeNumber",
    "productRatePlanChargeId": "productRatePlanChargeId",
    "productRatePlanNumber": "productRatePlanNumber",
    "uniqueToken": "uniqueToken",
    "customFields": {
      "key": "{}"
    }
  }
]
```

--------------------------------

### Example Payment Schedule Items

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule

This example shows the structure for an array of payment schedule items, including amount, scheduled date, and optional fields like currency and payment gateway ID.

```json
[
  {"amount":50,"scheduledDate":"2024-11-22"}
]
```

--------------------------------

### List all settings

Source: https://developer.zuora.com/v1-api-reference/api

Get a list of all available settings in your tenant. The response message is by default in JSON format.

```APIDOC
## GET /settings/listing

### Description
Get a list of all available settings in your tenant.

### Method
GET

### Endpoint
/settings/listing

### Parameters
#### Header Parameters
- **Accept** (string) - Optional - Set to application/csv to receive settings in CSV format.

### Response
#### Success Response (200)
- (Details not provided in source)

See a 200 response sample in CSV format that lists all available settings.
See a 200 response sample in JSON format that lists all available parameters of each setting.
You can find a specific operation of an available setting item in your tenant from the 200 response body of this call.
```

--------------------------------

### List all settings

Source: https://developer.zuora.com/v1-api-reference/api/settings

Get a list of all available settings in your tenant. The response is typically in JSON format but can be requested in CSV.

```APIDOC
## GET /settings/listing

### Description
Get a list of all available settings in your tenant. The response message is by default in JSON format. If you want to receive all the available settings in csv format, include Accept in the header parameters and set it to application/csv.

### Method
GET

### Endpoint
/settings/listing

### Parameters
#### Header Parameters
- **Accept** (string) - Optional - Set to `application/csv` to receive the response in CSV format.

### Response
#### Success Response (200)
- **settings** (array) - A list of all available settings in the tenant.
- **parameters** (object) - Details about the parameters for each setting.
```

--------------------------------

### Payment Option Detail Example

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview

An example of the `paymentOption` field, specifically demonstrating the `GatewayOptions` type with transactional details for the payment gateway.

```json
"paymentOption": [
  {
    "type": "GatewayOptions",
    "detail": {
      "SecCode":"WEB"
    }
  }
]
```

--------------------------------

### Example Payment Option with Gateway Details

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule

Demonstrates how to specify payment options for a payment schedule item, including the type and detailed gateway-specific information.

```json
[
  {
    "type": "GatewayOptions",
    "detail": {
      "SecCode":"WEB"
    }
  }
]
```

--------------------------------

### Run trial balance

Source: https://developer.zuora.com/v1-api-reference/api

Initiates the trial balance process for a specified accounting period. The trial balance runs asynchronously, and a successful response indicates the start of the process, not its completion. Use the Get Accounting Period REST API to monitor the trial balance outcome.

```APIDOC
## PUT /v1/accounting-periods/{ap-id}/run-trial-balance

### Description
Runs the trial balance for an accounting period.

### Method
PUT

### Endpoint
/v1/accounting-periods/{ap-id}/run-trial-balance

### Parameters
#### Path Parameters
- **ap-id** (string) - Required - The ID of the accounting period for which to run the trial balance.

### Notes
The trial balance is run asynchronously. A response of { "success": true } means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed. You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance.
```

--------------------------------

### Example Custom Fields for Rate Plan

Source: https://developer.zuora.com/v1-api-reference/api/orders/post_order

Illustrates how to include custom fields for a rate plan object when performing order actions.

```json
{
  "key": "{}"
}
```

--------------------------------

### List all details of source components

Source: https://developer.zuora.com/v1-api-reference/api

When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.

```APIDOC
## GET /deployment-manager/deployment_artifacts/retrieve-settings

### Description
When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.

### Method
GET

### Endpoint
/deployment-manager/deployment_artifacts/retrieve-settings
```

--------------------------------

### Retrieve Product Details

Source: https://developer.zuora.com/v1-api-reference/api/catalog/get_product

Use this endpoint to get all the information about a specific product. You need to provide the product's unique key in the path.

```APIDOC
## GET /v1/catalog/get_product/{product-key}

### Description
Retrieves the details of a specific product using its unique identifier.

### Method
GET

### Endpoint
/v1/catalog/get_product/{product-key}

### Parameters
#### Path Parameters
- **product-key** (string, required) - The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe, SKU-00000987, or PC-00000006.

### Response
#### Success Response (200)
- **category** (string) - Category of the product. Possible values: Base Products, Add On Services, Miscellaneous Products.
- **description** (string) - Optional product description.
- **effectiveEndDate** (string) - The date when the product expires and cannot be subscribed to anymore, as yyyy-mm-dd.
- **effectiveStartDate** (string) - The date when the product becomes available and can be subscribed to, as yyyy-mm-dd.
- **id** (string) - Product ID.
- **name** (string) - Product name, up to 100 characters.
- **organizationLabels** (array) - The organization(s) that the object belongs to. Available when the Multi-Org feature is enabled.
  - **organizationLabels.organizationId** (string) - The organization ID.
  - **organizationLabels.organizationName** (string) - The organization name.
- **productFeatures** (array) - Container for one or more product features. Available when Entitlements and Enable Feature Specification in Product and Subscriptions settings are enabled.
  - **productFeatures.code** (string) - Feature code, up to 255 characters long.
  - **productFeatures.description** (string) - Feature description.
  - **productFeatures.id** (string) - Feature ID.
  - **productFeatures.name** (string) - Feature name, up to 255 characters long.
  - **productFeatures.status** (string) - Status of the feature.
- **productNumber** (string) - The natural key of the product.
- **productRatePlans** (string) - URL to retrieve information about all product rate plans of a specific product. For example, /v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan. (Note: URL format depends on API version).
- **sku** (string) - Unique product SKU, up to 50 characters.
- **tags** (string) - Tags associated with the product.
- **IntegrationId__NS** (string) - ID of the corresponding object in NetSuite. Available if Zuora Connector for NetSuite is installed.
- **IntegrationStatus__NS** (string) - Status of the product's synchronization with NetSuite. Available if Zuora Connector for NetSuite is installed.
- **ItemType__NS** (string) - Type of item created in NetSuite for the product. Available if Zuora Connector for NetSuite is installed. Enum: "Inventory", "Non Inventory", "Service".
- **SyncDate__NS** (string) - Date when the product was synchronized with NetSuite. Available if Zuora Connector for NetSuite is installed.
```

--------------------------------

### Example v1 API Endpoint

Source: https://developer.zuora.com/v1-api-reference/api-versions.md

This is an example of a v1 API endpoint. The major version number appears in the URL.

```http
POST https://rest.zuora.com/v1/subscriptions
```

--------------------------------

### List schemas of a resource

Source: https://developer.zuora.com/v1-api-reference/api

Gets a specific resource schema by its ID.

```APIDOC
## GET /scim/v2/Schemas/{id}

### Description
Gets a specific resource schema by ID.

### Method
GET

### Endpoint
/scim/v2/Schemas/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the schema (e.g., "urn:ietf:params:scim:schemas:core:2.0:Group").
```

--------------------------------

### Compare and deploy a template for product catalog to a tenant

Source: https://developer.zuora.com/v1-api-reference/api/metadata-deployment

Compares and deploys a product catalog template to a tenant.

```APIDOC
## POST /deployment-manager/deployments/template/product_catalog

### Description
Compare and deploy a template for product catalog to a tenant.

### Method
POST

### Endpoint
/deployment-manager/deployments/template/product_catalog
```

--------------------------------

### Get Payment Schedule Item

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentscheduleitem

Retrieves details of a specific payment schedule item.

```APIDOC
## GET /v1/payment-schedules/{paymentScheduleId}/items/{paymentScheduleItemId}

### Description
Retrieves a specific payment schedule item by its ID within a given payment schedule.

### Method
GET

### Endpoint
/v1/payment-schedules/{paymentScheduleId}/items/{paymentScheduleItemId}

### Parameters
#### Path Parameters
- **paymentScheduleId** (string) - Required - The ID of the payment schedule.
- **paymentScheduleItemId** (string) - Required - The ID of the payment schedule item.

### Response
#### Success Response (200)
- **id** (string) - The ID of the payment schedule item.
- **paymentScheduleId** (string) - The ID of the associated payment schedule.
- **amount** (number) - The amount of the payment.
- **dueDate** (string) - The due date for the payment.
- **status** (string) - The status of the payment schedule item.

#### Response Example
```json
{
  "id": "8a12812a4567890abcdef1234567890",
  "paymentScheduleId": "8a12812a1234567890abcdef1234567890",
  "amount": 100.50,
  "dueDate": "2023-12-31",
  "status": "Due"
}
```

## Error Responses

### Response 4XX fields (application/json):

- `processId` (string) - The ID of the process that handles the operation.
- `reasons` (array) - The container of the error code and message. This field is available only if the success field is false.
  - `reasons.code` (string) - The error code of response.
  - `reasons.message` (string) - The detail information of the error response.
- `requestId` (string) - Unique identifier of the request.
- `success` (boolean) - Indicates whether the call succeeded.

### Response 500 fields (application/json):

- `reasons` (array) - Example: `[{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}]`
  - `reasons.code` (string) - The error code of response.
  - `reasons.message` (string) - The detail information of the error response.
```

--------------------------------

### Download a template

Source: https://developer.zuora.com/v1-api-reference/api

Downloads a template for migration in the Deployment manager from the source tenant to the target tenant.

```APIDOC
## GET /deployment-manager/deployment_artifacts

### Description
Download a template for migration in the Deployment manager from the source tenant to the target tenant.

### Method
GET

### Endpoint
/deployment-manager/deployment_artifacts
```

--------------------------------

### Create a deployment template

Source: https://developer.zuora.com/v1-api-reference/api

Creates templates based on user preference. It takes the environment details from the logged-in user automatically. Users can select components by selecting the whole component or using advanced options to select specific components.

```APIDOC
## POST /deployment-manager/deployment_templates

### Description
Creates templates based on user preference. There are 2 ways to select components: Selecting the whole component, or Advanced Options which helps user to select specific components to be migrated. It takes the environment details from the logged in user automatically, while creating the template.

### Method
POST

### Endpoint
/deployment-manager/deployment_templates
```

--------------------------------

### Retrieve the summary of a bulk job

Source: https://developer.zuora.com/v1-api-reference/api/bulk-data

Get the summary of a specific bulk job by its ID.

```APIDOC
## GET /bulk-data/bulk-jobs/{id}/summary

### Description
Get the summary of a specific bulk job by its ID. This operation returns a summary of the specified bulk job.

### Method
GET

### Endpoint
/bulk-data/bulk-jobs/{id}/summary

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the bulk job to retrieve the summary for.

### Request Body
(Details not provided in source)

### Response
#### Success Response (200)
(Details not provided in source)

### Request Example
(Details not provided in source)

### Response Example
(Details not provided in source)
```

--------------------------------

### Get Payment Schedule Details

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentschedule

This snippet details the fields returned when retrieving a payment schedule.

```APIDOC
## GET /payment-schedules/{paymentScheduleNumber}

### Description
Retrieves the details of a specific payment schedule.

### Method
GET

### Endpoint
/payment-schedules/{paymentScheduleNumber}

### Parameters
#### Path Parameters
- **paymentScheduleNumber** (string) - Required - The unique identifier of the payment schedule.

### Response
#### Success Response (200)
- **items.paymentScheduleNumber** (string) - Number of the payment schedule that contains the payment schedule item.
- **items.psiPayments** (array) - Container for payments linked to the payment schedule item.
  - **items.psiPayments.paymentId** (string) - ID of the payment.
- **items.runHour** (integer) - At which hour in the day in the tenant’s timezone this payment will be collected.
- **items.scheduledDate** (string) - The scheduled date when the payment is processed.
- **items.standalone** (boolean) - Indicates if the payment created by the payment schedule item is a standalone payment or not.
- **items.status** (string) - ID of the payment method of the payment schedule item. Enum: "Pending", "Processed", "Error", "Canceled"
- **items.updatedById** (string) - The ID of the user who updated the payment schedule item.
- **items.updatedDate** (string) - The date and time when the payment schedule item was last updated.
- **nextPaymentDate** (string) - The date the next payment will be processed.
- **occurrences** (integer) - The number of payment schedule items that are created by this payment schedule.
- **paymentOption** (array) - Container for the paymentOption items.
- **paymentScheduleNumber** (string) - Number of the payment schedule.
- **period** (string) - For recurring payment schedule only. The period of payment generation. Available values: Monthly, Weekly, BiWeekly.
- **prepayment** (boolean) - Indicates whether the payments created by the payment schedule are used as a reserved payment.
- **recentPaymentDate** (string) - The date the last payment was processed.
- **runHour** (integer) - At which hour in the day in the tenant’s timezone this payment will be collected.
- **standalone** (boolean) - Indicates if the payments that the payment schedule created are standalone payments.
- **startDate** (string) - The date when the first payment of this payment schedule is proccessed.
- **status** (string) - The status of the payment schedule. Enum: "Active", "Canceled", "Completed"
- **success** (boolean) - Returns true if the request was processed successfully.
- **totalAmount** (number) - The total amount that will be collected by the payment schedule.
- **totalPaymentsErrored** (integer) - The number of errored payments.
- **totalPaymentsProcessed** (integer) - The number of processed payments.
- **updatedById** (string) - The ID of the user who last updated this payment schedule.
- **updatedDate** (string) - The date and time the payment schedule is last updated.

#### Response Example
{
  "items": [
    {
      "paymentScheduleNumber": "ID402880e749b72b310149b7343ef80005",
      "psiPayments": [
        {
          "paymentId": "8a1284227c1234567890abcdef12345678"
        }
      ],
      "runHour": 10,
      "scheduledDate": "2023-10-26",
      "standalone": false,
      "status": "Processed",
      "updatedById": "user123",
      "updatedDate": "2023-10-25T10:00:00Z"
    }
  ],
  "nextPaymentDate": "2023-11-26",
  "occurrences": 12,
  "paymentOption": [],
  "paymentScheduleNumber": "ID402880e749b72b310149b7343ef80005",
  "period": "Monthly",
  "prepayment": false,
  "recentPaymentDate": "2023-09-26",
  "runHour": 10,
  "standalone": false,
  "startDate": "2023-10-26",
  "status": "Active",
  "success": true,
  "totalAmount": 1200.00,
  "totalPaymentsErrored": 0,
  "totalPaymentsProcessed": 1,
  "updatedById": "user123",
  "updatedDate": "2023-10-25T10:00:00Z"
}
```

--------------------------------

### Compare and deploy the product catalog of a tenant to a target tenant

Source: https://developer.zuora.com/v1-api-reference/api/metadata-deployment

Compares and deploys the product catalog of a tenant to a target tenant.

```APIDOC
## POST /deployment-manager/deployments/tenant/product_catalog

### Description
Compare and deploy the product catalog of a tenant to a target tenant.

### Method
POST

### Endpoint
/deployment-manager/deployments/tenant/product_catalog
```

--------------------------------

### Sign up

Source: https://developer.zuora.com/v1-api-reference/api/sign-up

This call performs multiple actions to sign up a customer, including validating account uniqueness, limiting subscriptions, creating a subscription, generating an invoice, and collecting payment. It can be used for both new and existing customers and supports asynchronous requests. While it offers unique abilities like Account UPSERT with custom external identifiers and subscription limits, the 'Create an order' call is generally recommended for its broader functionality in managing the subscription lifecycle.

```APIDOC
## POST /v1/sign-up

### Description
This operation performs multiple actions to sign up a customer, including validating account uniqueness, limiting subscriptions, creating a subscription, generating an invoice, and collecting payment. It can be used for both new and existing customers and supports asynchronous requests.

### Method
POST

### Endpoint
/v1/sign-up

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This section is not explicitly detailed in the source text, but the operation implies fields for account creation, payment method, subscription details, and product information.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
This section is not explicitly detailed in the source text, but a successful response would likely include details of the created account, subscription, and invoice.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Compare settings between a source tenant and a target tenant

Source: https://developer.zuora.com/v1-api-reference/api

Compares configurations from a template downloaded and used in Deployment Manager for migration, which is available in the source and target tenant.

```APIDOC
## POST /deployment-manager/deployment_artifacts/compare

### Description
To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.

### Method
POST

### Endpoint
/deployment-manager/deployment_artifacts/compare
```

--------------------------------

### GET /v1/payment-methods/wallet/domains

Source: https://developer.zuora.com/v1-api-reference/api

Retrieves a list of registered wallet domains. This can be filtered by a domain name query parameter.

```APIDOC
## GET /v1/payment-methods/wallet/domains

### Description
Use this operation to retrieve a list of registered domains. You can use `domainName` as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domains containing the specified domain name will be returned.

### Method
GET

### Endpoint
/v1/payment-methods/wallet/domains

### Parameters
#### Query Parameters
- **domainName** (string) - Optional - Filters the list to return only domains containing this name.

### Response
#### Success Response (200)
- (No specific fields mentioned in the source)
```

--------------------------------

### Get Billing Preview Run Details

Source: https://developer.zuora.com/v1-api-reference/api/billing-preview-run/get_billingpreviewrun

Fetches the details of a specific billing preview run by its ID.

```APIDOC
## GET /v1/billing-preview-runs/{billingPreviewRunId}

### Description
Retrieves the details of a specific billing preview run.

### Method
GET

### Endpoint
/v1/billing-preview-runs/{billingPreviewRunId}

### Parameters
#### Path Parameters
- **billingPreviewRunId** (string) - Required - Id of the billing preview run.

### Response
#### Success Response (200)
- **assumeRenewal** (string) - 
- **batches** (string) - The customer batches included in the billing preview run. 
- **chargeTypeToExclude** (string) - The charge types excluded from the forecast run.
- **createdById** (string) - The ID of the user who created the billing preview run.
- **createdDate** (string) - The date and time when the billing preview run was created.
- **endDate** (string) - The date and time when the billing preview run completes.
- **errorMessage** (string) - The error message generated by a failed billing preview run.
- **includingDraftItems** (boolean) - Whether draft document items are included in the billing preview run. By default, draft document items are not included.
- **includingEvergreenSubscription** (boolean) - Indicates if evergreen subscriptions are included in the billing preview run.
- **organizationLabels** (array) - The organization(s) that the object belongs to. 
  - **organizationLabels.organizationId** (string) - The organization ID.
  - **organizationLabels.organizationName** (string) - The organization name.
- **resultFileUrl** (string) - The URL of the zipped CSV result file generated by the billing preview run. This file contains the preview invoice item data and credit memo item data for the specified customers.
- **runNumber** (string) - The run number of the billing preview run.
- **startDate** (string) - The date and time when the billing preview run starts.
- **status** (string) - The status of the billing preview run. Possible values: 0: Pending, 1: Processing, 2: Completed, 3: Error, 4: Canceled
- **storageOption** (string) - The saving options. Enum: "Csv", "Database"
- **succeededAccounts** (integer) - The number of accounts for which preview invoice item data and credit memo item data was successfully generated during the billing preview run.
- **success** (boolean) - Returns true if the request was processed successfully.
- **targetDate** (string) - The target date for the billing preview run.
- **totalAccounts** (integer) - The total number of accounts in the billing preview run.
- **updatedById** (string) - The ID of the user who last updated the billing preview run.
- **updatedDate** (string) - The date and time when the billing preview run was last updated.

#### Response Example
{
  "assumeRenewal": "string",
  "batches": "string",
  "chargeTypeToExclude": "string",
  "createdById": "string",
  "createdDate": "string",
  "endDate": "string",
  "errorMessage": "string",
  "includingDraftItems": true,
  "includingEvergreenSubscription": true,
  "organizationLabels": [
    {
      "organizationId": "string",
      "organizationName": "string"
    }
  ],
  "resultFileUrl": "string",
  "runNumber": "string",
  "startDate": "string",
  "status": "string",
  "storageOption": "Csv",
  "succeededAccounts": 0,
  "success": true,
  "targetDate": "string",
  "totalAccounts": 0,
  "updatedById": "string",
  "updatedDate": "string"
}
```

--------------------------------

### Compare and deploy a template to a tenant

Source: https://developer.zuora.com/v1-api-reference/api/metadata-deployment

Compares and deploys a specified template to a tenant.

```APIDOC
## POST /deployment-manager/deployments/templates

### Description
Compare and deploy a template to a tenant.

### Method
POST

### Endpoint
/deployment-manager/deployments/templates
```

--------------------------------

### Get Payment Schedule Item by ID

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentscheduleitem

Fetches the details of a payment schedule item using its unique identifier.

```APIDOC
## GET /api/payment-schedules/{psi-id}

### Description
Retrieves the details of a specific payment schedule item.

### Method
GET

### Endpoint
/api/payment-schedules/{psi-id}

### Parameters
#### Path Parameters
- **psi-id** (string) - Required - The unique ID of a payment schedule item.

### Response
#### Success Response (200)
- **accountId** (string) - ID of the customer account that owns the payment schedule item, for example 402880e741112b310149b7343ef81234.
- **amount** (number) - The total amount of the payment schedule item.
- **balance** (number) - The remaining balance of payment schedule item.
- **billingDocument** (object) - 
  - **id** (string) - ID of the billing document. for example, 2c9890306fb2121e016fb21a6b550041.
  - **number** (string) - The number of the billing docuemnt, for example, INV00002345.
  - **type** (string) - Indicates whether the associated billing document is a debit memo or a invoice.
- **cancellationReason** (string,null) - The reason for the cancellation of payment schedule item.
- **cancelledById** (string,null) - The ID of the user who canceled this payment schedule item.
- **cancelledOn** (string,null) - The date when the payment schedule item was canceled.
- **createdById** (string) - The ID of the user who created the payment schedule item.
- **createdDate** (string) - The date and time when the payment schedule item was created.
- **currency** (string) - The currency of the payment.
- **description** (string) - The description of the payment schedule item.
- **errorMessage** (string) - The error message indicating if the error is related to the configuration or the payment collection.
- **id** (string) - ID of the payment schedule item. For example, 412880e749b72b310149b7343ef81346.
- **number** (string) - Number of the payment schedule item.
- **paymentGatewayId** (string,null) - ID of the payment gateway of the payment schedule item.
- **paymentMethodId** (string) - ID of the payment method of the payment schedule item.
- **paymentOption** (array) - Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.
  - **detail** (object) - The field used to pass the transactional payment data to the gateway side in the key-value format.
    - **key** (string) - The name of the field.
    - **value** (string) - The value of the field.
  - **type** (string) - The type of the payment option. Currently, only GatewayOptions is supported for specifying Gateway Options fields supported by a payment gateway.
- **paymentScheduleId** (string) - ID of the payment schedule that contains the payment schedule item, for example, ID402880e749b72b310149b7343ef80005,
- **paymentScheduleNumber** (string) - Number of the payment schedule that contains the payment schedule item, for example, ID402880e749b72b310149b7343ef80005,
- **psiPayments** (array) - Container for payments linked to the payment schedule item.
  - **paymentId** (string) - ID of the payment.
- **runHour** (integer) - At which hour in the day in the tenant’s timezone this payment will be collected. If the payment runHour and scheduledDate are backdated, the system will collect the payment when the next runHour occurs.
- **scheduledDate** (string) - The scheduled date when the payment is processed.
- **standalone** (boolean) - Indicates if the payment created by the payment schedule item is a standalone payment.
- **status** (string) - ID of the payment method of the payment schedule item. Enum: "Pending", "Processed", "Error", "Canceled"
- **success** (boolean) - Returns true if the request was processed successfully.
- **updatedById** (string) - The ID of the user who updated the payment schedule item.
- **updatedDate** (string) - The date and time when the payment schedule item was last updated.
```

--------------------------------

### Create a product

Source: https://developer.zuora.com/v1-api-reference/api/products

Creates a new product object in your product catalog.

```APIDOC
## POST /v1/object/product

### Description
Creates a new product.

### Method
POST

### Endpoint
/v1/object/product
```

--------------------------------

### List Active Retry Cycles for an Account

Source: https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry

Gets information of active retry cycles that have not been completed for a specific account.

```APIDOC
## List the active retry cycles for an account

### Description
Gets information of active retry cycles that have not been completed for an account in Configurable Payment Retry.

### Method
GET

### Endpoint
/api/v1/payments/active_account_cycle_information/{account_id}
```

--------------------------------

### POST /billing-preview-run

Source: https://developer.zuora.com/v1-api-reference/api/billing-preview-run/post_billingpreviewrun

Initiates a billing preview run. This endpoint returns details about the created billing preview run or any errors encountered.

```APIDOC
## POST /billing-preview-run

### Description
Initiates a billing preview run. This endpoint returns details about the created billing preview run or any errors encountered.

### Method
POST

### Endpoint
/v1/billing-preview-run

### Response
#### Success Response (200)
- **billingPreviewRunId** (string) - Id of the billing preview run.
- **success** (boolean) - Returns true if the request was processed successfully.

#### Response Example
```json
{
  "billingPreviewRunId": "a1b2c3d4e5f67890",
  "success": true
}
```

#### Error Response (4XX/500)
- **processId** (string) - The ID of the process that handles the operation. (Available for 4XX responses)
- **reasons** (array) - The container of the error code and message. This field is available only if the success field is false.
  - **reasons.code** (string) - The error code of response.
  - **reasons.message** (string) - The detail information of the error response.

#### Response Example (4XX/500)
```json
{
  "processId": "proc_12345",
  "reasons": [
    {
      "code": "ObjectNotFound",
      "message": "Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"
    }
  ],
  "success": false,
  "requestId": "req_abcde"
}
```
```

--------------------------------

### Compare and deploy a source tenant to a target tenant

Source: https://developer.zuora.com/v1-api-reference/api/metadata-deployment

Compares and deploys metadata from a source tenant to a target tenant.

```APIDOC
## POST /deployment-manager/deployments/tenants

### Description
Compare and deploy a source tenant to a target tenant.

### Method
POST

### Endpoint
/deployment-manager/deployments/tenants
```

--------------------------------

### List Active Retry Cycles for an Invoice

Source: https://developer.zuora.com/v1-api-reference/api/configurable-payment-retry

Gets information of active retry cycles that have not been completed for a specific invoice.

```APIDOC
## List the active retry cycles for an invoice

### Description
Gets information of active retry cycles that have not been completed for an invoice in Configurable Payment Retry.

### Method
GET

### Endpoint
/api/v1/payments/active_invoice_cycle_information/{invoice_id}
```

--------------------------------

### Sign up

Source: https://developer.zuora.com/v1-api-reference/api

A light-weight API to sign up customers and subscribe them to products. It can create accounts, payment methods, subscriptions, generate invoices, and collect payments.

```APIDOC
## POST /v1/sign-up

### Description
This call performs many actions to sign up a customer and subscribe them. It can validate account uniqueness, limit subscriptions per account, create a subscription, generate an invoice, and collect payment. It supports Account UPSERT functionality and limiting subscriptions per account.

### Method
POST

### Endpoint
/v1/sign-up

### Parameters
#### Request Body
This endpoint accepts a request body with various fields to define the customer, account, payment method, and subscription details. Specific fields are not detailed in the source text but are implied by the described functionality (e.g., account information, payment details, product subscription information).

### Request Example
(Request body structure not provided in source text)

### Response
(Response details not provided in source text)
```

--------------------------------

### Get Payment Schedules Response Fields

Source: https://developer.zuora.com/v1-api-reference/api/payment-schedules/get_paymentschedules

This section details the fields returned when retrieving payment schedules via the API.

```APIDOC
## Get Payment Schedules Response

### Response Fields (application/json):

- `items.psiPayments.paymentId` (string) - ID of the payment.
- `items.runHour` (integer) - At which hour in the day in the tenant’s timezone this payment will be collected.
- `items.scheduledDate` (string) - The scheduled date when the payment is processed.
- `items.standalone` (boolean) - Indicates if the payment created by the payment schedule item is a standalone payment or not.
- `items.status` (string) - ID of the payment method of the payment schedule item. Enum: "Pending", "Processed", "Error", "Canceled"
- `items.updatedById` (string) - The ID of the user who updated the payment schedule item.
- `items.updatedDate` (string) - The date and time when the payment schedule item was last updated.
- `nextPaymentDate` (string) - The date the next payment will be processed.
- `occurrences` (integer) - The number of payment schedule items that are created by this payment schedule.
- `paymentOption` (array) - Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.
- `paymentScheduleNumber` (string) - Number of the payment schedule.
- `period` (string) - For recurring payment schedule only. The period of payment generation. Available values include: Monthly, Weekly, BiWeekly. Returns null for custom payment schedules.
- `prepayment` (boolean) - Indicates whether the payments created by the payment schedule are used as a reserved payment.
- `recentPaymentDate` (string) - The date the last payment was processed.
- `runHour` (integer) - [0,1,2,~,22,23] At which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected. Return 0 for custom payment schedules.
- `standalone` (boolean) - Indicates if the payments that the payment schedule created are standalone payments or not.
- `startDate` (string) - The date when the first payment of this payment schedule is proccessed.
- `status` (string) - The status of the payment schedule. Enum: "Active", "Canceled", "Completed"
- `totalAmount` (number) - The total amount that will be collected by the payment schedule.
- `totalPaymentsErrored` (integer) - The number of errored payments.
- `totalPaymentsProcessed` (integer) - The number of processed payments.
- `updatedById` (string) - The ID of the user who last updated this payment schedule.
- `updatedDate` (string) - The date and time the payment schedule is last updated.
```

--------------------------------

### Create Billing Preview Run

Source: https://developer.zuora.com/v1-api-reference/api/billing-preview-run/post_billingpreviewrun

Initiates a billing preview run for specified customer accounts. This operation can be made idempotent using the `Idempotency-Key` header.

```APIDOC
## POST /v1/billing-preview-runs

### Description
Creates a billing preview run for single and multiple customer accounts.

### Method
POST

### Endpoint
/v1/billing-preview-runs

### Header parameters
- **Idempotency-Key** (string) - Optional - Specify a unique idempotency key to ensure the request is processed only once.
- **Accept-Encoding** (string) - Optional - Include `gzip` to compress responses.
- **Content-Encoding** (string) - Optional - Include `gzip` to compress the request payload.
- **Zuora-Track-Id** (string) - Optional - A custom identifier for tracing the API call.
- **Zuora-Entity-Ids** (string) - Optional - Specify the entity ID for multi-entity accounts.
- **Zuora-Org-Ids** (string) - Optional - Comma separated IDs to specify which orgs to perform the operation in for multi-org accounts.
- **Zuora-Version** (string) - Optional - The minor API version.

### Request Example
{
  "example": "request body"
}

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Create a product rate plan

Source: https://developer.zuora.com/v1-api-reference/api/commerce

Creates a product rate plan (Plan) under an existing product. Each plan must include essential charge details like name, model, type, bill cycle, trigger event, end date condition, and pricing.

```APIDOC
## POST /commerce/plans

### Description
Create a product rate plan (Plan) under an existing product. A plan includes one or more charges. Each charge must include:
  - name
  - charge_model
  - charge_type
  - bill_cycle
  - trigger_event
  - end_date_condition
  - pricing

Optional charge fields include: unit_of_measure, list_price_base, and accounting (with accounting_code, deferred_revenue_account, recognized_revenue_account).

### Method
POST

### Endpoint
/commerce/plans
```

--------------------------------

### Get Catalog

Source: https://developer.zuora.com/v1-api-reference/api/catalog/get_catalog

Retrieves a list of products from the catalog. You can control the number of results per page and the specific page number.

```APIDOC
## GET /catalog

### Description
Retrieves a list of products from the catalog with pagination support.

### Method
GET

### Endpoint
/catalog

### Query Parameters
#### Query Parameters
- **page** (integer) - Optional - 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.
- **pageSize** (integer) - Optional - The number of records returned per page in the response.

### Response
#### Success Response (200)
- **nextPage** (string) - URL to retrieve the next page of the response if it exists; otherwise absent.
- **products** (array) - Container for one or more products:
  - **products.category** (string) - Category of the product. Possible values: Base Products, Add On Services, Miscellaneous Products.
  - **products.description** (string) - Optional product description.
  - **products.effectiveEndDate** (string) - The date when the product expires and cannot be subscribed to anymore, as yyyy-mm-dd.
  - **products.effectiveStartDate** (string) - The date when the product becomes available and can be subscribed to, as yyyy-mm-dd.
  - **products.id** (string) - Product ID.
  - **products.name** (string) - Product name, up to 100 characters.
  - **products.organizationLabels** (array) - The organization(s) that the object belongs to. Only available when the Multi-Org feature is enabled:
    - **products.organizationLabels.organizationId** (string) - The organization ID.
    - **products.organizationLabels.organizationName** (string) - The organization name.
  - **products.productFeatures** (array) - Container for one or more product features. Only available when specific features are enabled:
    - **products.productFeatures.code** (string) - Feature code, up to 255 characters long.
    - **products.productFeatures.description** (string) - Feature description.
    - **products.productFeatures.id** (string) - Feature ID.
    - **products.productFeatures.name** (string) - Feature name, up to 255 characters long.
    - **products.productFeatures.status** (string) - Status of the feature.
  - **products.productNumber** (string) - The natural key of the product.
  - **products.productRatePlans** (string) - URL to retrieve information about all product rate plans of a specific product.
  - **products.sku** (string) - Unique product SKU, up to 50 characters.
  - **products.tags** (string) - Tags associated with the product.
  - **products.IntegrationId__NS** (string) - ID of the corresponding object in NetSuite. Only available if the Zuora Connector for NetSuite is installed.
  - **products.IntegrationStatus__NS** (string) - Status of the product's synchronization with NetSuite. Only available if the Zuora Connector for NetSuite is installed.
  - **products.ItemType__NS** (string) - Type of item created in NetSuite for the product. Enum: "Inventory", "Non Inventory", "Service". Only available if the Zuora Connector for NetSuite is installed.
  - **products.SyncDate__NS** (string) - Date when the product was synchronized with NetSuite. Only available if the Zuora Connector for NetSuite is installed.
- **success** (boolean) - Returns true if the request was processed successfully.

#### Response Example
{
  "nextPage": "/v1/catalog?pageSize=1&page=2",
  "products": [
    {
      "category": "Base Products",
      "description": "This is a sample product description.",
      "effectiveEndDate": "2025-12-31",
      "effectiveStartDate": "2023-01-01",
      "id": "8a1281216463d683016463ef8b7301a0",
      "name": "Sample Product",
      "organizationLabels": [
        {
          "organizationId": "org123",
          "organizationName": "Organization A"
        }
      ],
      "productFeatures": [
        {
          "code": "FEAT001",
          "description": "Basic feature",
          "id": "feat123",
          "name": "Basic Feature",
          "status": "enabled"
        }
      ],
      "productNumber": "PROD-001",
      "productRatePlans": "/v1/rateplan/8a1281216463d683016463ef8b7301a0/productRatePlan",
      "sku": "SKU12345",
      "tags": "tag1,tag2",
      "IntegrationId__NS": "ns123",
      "IntegrationStatus__NS": "Synced",
      "ItemType__NS": "Inventory",
      "SyncDate__NS": "2023-10-27T10:00:00Z"
    }
  ],
  "success": true
}
```