# Returns a installment schedule from the system by its ID.

This method will look up a installment schedule by the specified ID and return it back.

Endpoint: GET /installmentSchedules/{tenantId}/{id}
Version: v1-2025-04-18
Security: knox-authorizer

## Path parameters:

  - `tenantId` (string, required)
    The id of the tenant being accessed.

  - `id` (string, required)
    The ID of the installment schedule to return.

## Query parameters:

  - `fields` (string)
    The fields that you want to retrieve; if omitted, the entire object is returned.

  - `consistentRead` (string)
    Indicates the API should force a consistent read on the data source.

## Response 200 fields (application/json):

  - `amount_billed` (number, required)
    Amount of pledge fulfilled

  - `amount_outstanding` (number, required)
    The amount of outstanding on the pledge

  - `billing_address` (object)
    A complete address

  - `billing_address.city` (string)
    The city of the address

  - `billing_address.country` (string)
    The country ISO code

  - `billing_address.country_name` (string)
    The full name of hte country

  - `billing_address.county` (string)
    The county

  - `billing_address.latitude` (number)

  - `billing_address.line1` (string)
    The first line of the address

  - `billing_address.line2` (string)
    The second line of the address

  - `billing_address.line3` (string)
    The third line of the address

  - `billing_address.longitude` (number)

  - `billing_address.postal_code` (string)
    The zip/postal code

  - `billing_address.state` (string)
    The state/province of the address

  - `billing_address.time_zone_id` (string)

  - `business_unit_id` (string, required)
    The business unit

  - `contact_id` (string, required)

  - `currency_code` (string, required)
    The currency this schedule should be billing
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR"

  - `date_cancelled` (string, required)
    The date the schedule was cancelled

  - `date_last_processed` (string, required)
    The last time this schedule was processed

  - `date_of_last_reminder` (string)
    The date that the last reminder was sent for this schedule having a declined payment

  - `electronic_payment_info` (object)

  - `electronic_payment_info.card_expiration` (string)
    The expiration date of the card

  - `electronic_payment_info.card_type` (string)
    The type of card being used, or CHECK if electronic check
    Enum: "american express", "discover", "electronic check", "mastercard", "other", "visa"

  - `electronic_payment_info.merchant_account_tokens` (array)

  - `electronic_payment_info.merchant_account_tokens.merchant_account_id` (string, required)
    The merchant account id

  - `electronic_payment_info.merchant_account_tokens.token` (string, required)
    The token representing the card/electronic check info

  - `electronic_payment_info.payment_account` (string)
    The masked payment account information

  - `electronic_payment_info.payment_origin` (string, required)
    Whether or not this is a saved payment method
    Enum: "ad hoc", "saved", "single token"

  - `electronic_payment_info.token` (string)
    For integrated payments, the single token

  - `electronic_payment_info.type` (string, required)
    The type of payment
    Enum: "credit card", "electronic check"

  - `entries` (array, required)

  - `entries.amount` (number, required)
    The amount of the entry

  - `entries.billing_run_action_id` (string)
    The billing run action ID last associated with this entry

  - `entries.billing_run_id` (string)
    The billing run ID last associated with this entry

  - `entries.date` (string, required)
    The date of the entry

  - `entries.entry_id` (string, required)
    A unique entry identifier

  - `entries.installment_plan_id` (string)
    The installment plan

  - `entries.invoice_id` (string)
    The invoice tied to this entry, if it has been processed

  - `entries.line_item_description` (string)
    Description of the line item

  - `entries.order_id` (string)
    The order tied to this entry, if it has been processed and is a perpetual entry

  - `entries.order_line_item_id` (string, required)
    The order line item that created this schedule

  - `entries.payment_id` (string)
    The payment tied to this entry, if it has been processed

  - `entries.perpetual_options` (object)

  - `entries.perpetual_options.end_date` (string)
    For perpetual schedules, the date to end

  - `entries.perpetual_options.number_of_units` (number, required)
    Number of units

  - `entries.perpetual_options.unit_of_time` (string, required)
    Enum: "months", "quarters", "weeks", "years"

  - `entries.product_id` (string, required)
    The product ID

  - `entries.product_name` (string, required)
    Name of the product

  - `entries.product_type` (string, required)
    The product type

  - `entries.status` (string, required)
    The status of the schedule entry
    Enum: "open", "processed", "processing"

  - `entries.transient_transaction_id` (string)
    The "transient" transaction (which may fail)

  - `entries.transient_transaction_type` (string)
    The "transient" transaction (which may fail)
    Enum: "order", "payment"

  - `entries.type` (string)
    The type of entry
    Enum: "based on installment plan", "perpetual"

  - `error_message` (string)
    The last error message experienced by this schedule

  - `id` (string, required)
    The unique, string identifier of this installment schedule

  - `invoice_terms_id` (string)
    The invoice terms

  - `merchant_account_id` (string)
    The merchant account being used

  - `next_processing_date` (string)
    The date of next processing for this schedule

  - `notes` (string)
    Any relevant notes

  - `number` (number)
    Number of the plan, which should match order #

  - `order_process_id` (string)
    The process ID of the order

  - `order_type` (string, required)
    Order type

  - `organization_id` (string, required)

  - `owner_type` (string, required)
    Enum: "contact", "organization"

  - `pay_for_credit_card_processing_fees` (boolean)
    Whether or not we are billing for processing fees

  - `remaining_number_of_installments` (number, required)
    The number of payments remaining on the pledge

  - `status` (string, required)
    The status of the schedule
    Enum: "active", "cancelled", "completed", "error", "payment declined", "suspended"

  - `store_id` (string)
    Store ID, if an online store

  - `suspended_until` (string)
    If the schedule is suspended, the date until which it is suspended

  - `sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `sys_bulk_load_pk` (string)
    If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

  - `sys_bulk_load_record_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `sys_calculated_field_errors` (array)

  - `sys_calculated_field_errors.error` (string)

  - `sys_calculated_field_errors.field` (string)

  - `sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `sys_created_by_id` (string, required)
    The ID of the user that created this record

  - `sys_deleted_by_id` (string)
    The ID of the user that deleted (or last tried to delete) this object

  - `sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `sys_has_files_in_s3` (boolean)
    If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

  - `sys_last_bulk_data_operation_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `sys_version` (number)
    A number representing the version of this record in the database

  - `use_pro_forma_invoices` (boolean)
    Whether pro forma invoices should be generated


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields