Create Subscription, Scheduled Payment, or Autopay

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}

Customer's billing address.

Additional line for Customer's billing address.

Customer's billing city.

Customer's billing country.

Customer's email address.

Customer's phone number.

Customer's billing state. Must be 2-letter state code for address in US.

Customer's billing ZIP code.

Customer's company name.

The Payabli-generated unique ID for the customer.

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Customer/Payor first name.

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Customer/Payor last name.

The shipping address.

Additional line for shipping address.

Shipping city.

Shipping address country.

Shipping state or province.

Shipping ZIP code.

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Array of fileContent objects with attached documents. Max upload size is 30 MB.

Company name of the recipient of the invoice.

Discount applied to the invoice.

Duty amount.

First name of the recipient of the invoice.

Freight/shipping amount.

Frequency of scheduled invoice.

Invoice total amount.

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Invoice number. Identifies the invoice under a paypoint.

Status for invoice.

The accepted status values are:

• 0 draft
• 1 active
• 2 partially paid
• 4 paid/complete
• 99 cancelled

Type of invoice. Only 0 for one-time invoices is currently supported.

Array of line items included in the invoice.

Last name of the recipient of the invoice.

Notes included in the invoice.

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Purchase order number.

The shipping address.

Additional line for shipping address.

Shipping city.

Shipping address country.

Shipping recipient's contact email address.

Sender shipping ZIP code.

Recipient phone number.

Shipping state or province.

Shipping ZIP code.

Commodity code.

Tax rate in percent applied to the invoice.

Custom terms and conditions included in the invoice.

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.

Object containing image of paper check.

A check number to be used in the ach transaction. Required for payment method = 'check'.

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.

Split funding instructions for the transaction. See Split a Transaction for more.

Subscription end date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY or the value untilcancelled to indicate a scheduled payment with infinite cycle.

Frequency of the subscription.

This field is for future development, leave null. Identifier of subscription plan applied in the scheduled payment/subscription.

Subscription start date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. This must be a future date.