Skip to main content

Scheduling payments for invoices

POST 
/api/v3/invoice/:invoice_id/_action/schedule

ChargeOver allows you to schedule a full payment or several partial payments to invoices via the REST API. You must specify the amount and date of the payment.

For invoices created from a subscription, the payment method used is always the payment method from the subscription itself.

For one-time invoices, you can specify a credit card, bank account, or tokenized payment method to be used for the payment by providing the creditcard_id, ach_id, or tokenized_id in the paymethod field. Otherwise, you can use any to allow any of the customer's stored payment methods to be used.

You can also use crd to have the payment charged to any credit card stored for the customer, ach to specify the payment method as any of the stored ACH bank accounts the customer has, or tok to specify the payment method as any of the stored tokenized payment methods the customer has.

Request​

Body

    schedule

    object

    0

    object

    _comment string
    amount number
    date string
    creditcard_id integer

    1

    object

    _comment string
    amount number
    date string
    paymethod string

    2

    object

    _comment string
    amount number
    date string
    paymethod string

    3

    object

    _comment string
    amount number
    date string
    paymethod string

Responses​

Action completed successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable
    response boolean
Loading...