---
title: "Retrieve an invoice schedule"
method: GET
path: "/v1/invoice-schedules/{scheduleKey}"
tags: ["Invoice Schedules"]
---

# Retrieve an invoice schedule

`GET /v1/invoice-schedules/{scheduleKey}`

Retrieves detailed information about an invoice schedule.

**Note**: This operation is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-billing-schedule-overview" target="_blank">Billing Schedule</a> feature enabled.

## Path parameters

- `scheduleKey` string, required

## Query parameters

- `page` integer
- `pageSize` integer

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- InvoiceScheduleResponses — Container for custom fields of an Invoice Schedule object.
  - `accountId` string — The ID of the customer account that the invoice schedule belongs to.
  - `actualAmount` number — The actual amount that needs to be billed during the processing of the invoice schedule. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `totalAmount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.
  - `additionalSubscriptionsToBill` string[] — A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions.
  - `billedAmount` number — The amount that has been billed during the processing of the invoice schedule.
  - `currency` string — The currency of the billing documents generated during the processing of the invoice schedule. **Note**: - This field is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currencies</a> feature enabled. - If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used.
  - `id` string — The unique ID of the invoice schedule.
  - `invoiceSeparately` boolean — Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.
  - `nextRunDate` string, date — The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null.
  - `notes` string — Comments on the invoice schedule.
  - `number` string — The sequence number of the invoice schedule.
  - `orders` string[] — A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.
  - `scheduleItems` ScheduleItemsResponse[] — Container for schedule items. One invoice schedule can have at most 50 invoice schedule items.
    - `actualAmount` string, number — The actual amount that needs to be billed during the processing of the invoice schedule item. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `amount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.
    - `amount` string, number — The amount of the invoice generated during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. The value of this field keeps unchanged once invoice schedule items are created.
    - `creditMemoId` string — The ID of the credit memo that is generated during the processing of the invoice schedule item.
    - `id` string — The unique ID of the invoice schedule item.
    - `invoiceId` string — The ID of the invoice that is generated during the processing of the invoice schedule item.
    - `name` string — The name of the invoice schedule item.
    - `percentage` unknown
    - `runDate` string, date — The date in the tenant’s time zone when the invoice schedule item is processed to generate an invoice.
    - `status` 'Pending' | 'Executing' | 'Processed' — The status of the invoice schedule item.
    - `targetDateForAdditionalSubscriptions` string, date — The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field.
    - `organizationLabel` string — Indicates the organization assigned to the Invoice Schedule Item for multi-org.
  - `specificSubscriptions` InvoiceScheduleSpecificSubscriptions[] — A list of the numbers of specific subscriptions associated with the invoice schedule.
    - `chargeNumbers` string — A list of charges in the subscription that are chosen to be included in the invoice schedule.
    - `orderKey` string — The unique ID or number of the order associated with the invoice schedule.
    - `subscriptionKey` string — The unique number of the subscription contained in the order associated with the invoice schedule.
  - `status` 'Pending' | 'PartiallyProcessed' | 'Paused' | 'FullyProcessed' — The status of the invoice schedule.
  - `totalAmount` number — The total amount that needs to be billed during the processing of the invoice schedule. The value of this field keeps unchanged once invoice schedule items are created.
  - `unbilledAmount` number — The amount that is waiting to be billed during the processing of the invoice schedule.
  - `organizationLabel` string — Indicates the organization assigned to the Invoice Schedule for multi-org.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)