Get 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. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "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.

Timestamp of when record was created, in UTC.

The Payabli-generated unique ID for the customer.

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 Status. Possible values:

• -99 Deleted
• 0 Inactive
• 1 Active
• 85 Locked (typically due to multiple failed login attempts)

Customer/Payor first name.

Array of field names to be used as identifiers.

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.

Expiration date of card used in transaction.

Custom identifier for payment connector.

Bank account type or card brand.

ZIP code for card used in transaction.

Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay.

Account holder name for the method.

Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.

Available values:

• payor: For cardholder-initiated transactions
• merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Text description of the transaction.

Details about the payment.

The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.

Available values:

• first: The first use of the payment method. This is almost always a cardholder-initiated transaction.
• subsequent: For merchant-initiated transactions after the first use of the payment method.

See Understanding CIT and MIT Indicators for more information.

Identifier of stored payment method used in transaction.

Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled.

Available values:

• unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.
• subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.
• recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.

See Understanding CIT and MIT Indicators for more information.