API Doc Version 1.1.8

API Doc Version 1.1.8 Changes.

What's New

POST /email/send-unsubscribed-confirmation-email

Unsubscribed Product

POST /email/send-successful-unsubscribtion-email

Unsubscribed Successfully

POST /set-dealer

Register Dealer

POST /get-providers

Get Providers

POST /get-provider-products

Get Provider Products

POST /get-dealer-products

Get Dealer Products

POST /set-dealer-fni-products

Set Dealer F&I Products

POST /get-program-codes

Get Program Codes

POST /get-ratebook-codes

Get RateBook Codes

POST /get-dealer-surcharges

Get Dealer Surcharges

POST /get-rates

Get Rates

POST /get-template

Get Template

POST /get-filled-form

Get Filled Form

POST /get-preview

Get Preview

POST /void-contract

Void Contract

POST /identity/auto-verify-license

Auto Verify License

POST /identity/manual-license-review

Manual License Review

GET /identity/poll

Retrieve Manual License Review Updates

GET /identity/retrieve-manual-results/{retrieval_id}

Retrieve Manual License Review Result

POST /tradein/get-tradein-years

Years

POST /tradein/get-tradein-makes

Makes

POST /tradein/get-tradein-models

Models

POST /tradein/get-tradein-trims

Trims

POST /tradein/get-tradein-allOptions

Options

POST /tradein/get-tradein-vehicleValue

Vehicle Value

POST /tradein/get-tradein-decodevin

Decode VIN

POST /payment/payment/webhooks

Handle payment webhooks

GET /payment/subscriptions/search

Search Subscriptions

GET /payment/invoices/search

Search Invoices

POST /payment/invoices/upcoming

Upcoming Invoices

POST /payment/invoices/upcoming/line

Upcoming Line Items

POST /payment/invoices/{invoice_id}/void

Void an Invoice

POST /payment/invoices/{invoice_id}/mark_uncollectible

Mark uncollectible

GET /payment/invoices/{invoice_id}/lines

Retrieve an invoice's line items

GET /payment/subscription-items

List subscription items

POST /payment/subscription-items

Create a subscription item

GET /payment/subscription-items/{subscription_item_id}

Get a subscription item

DELETE /payment/subscription-items/{subscription_item_id}

Delete a subscription item

PATCH /payment/subscription-items/{subscription_item_id}

Update a subscription item

POST /account-verification/link/token

Create link token

POST /account-verification/public-token/exchange

Exchange public token for an access token

POST /account-verification/stripe/bank-account-token

Create Stripe bank account token

POST /account-verification/accounts/balance/get

Retrieve real-time balance data

GET /payment/subscriptions

List Subscriptions

GET /payment/invoices

List all invoices

What's Deleted

POST /pen/set-dealer

Register Dealer

POST /pen/get-providers

Get Providers

POST /pen/get-provider-products

Get Provider Products

POST /pen/get-dealer-products

Get Dealer Products

POST /pen/set-dealer-fni-products

Set Dealer F&I Products

POST /pen/get-program-codes

Get Program Codes

POST /pen/get-ratebook-codes

Get RateBook Codes

POST /pen/get-dealer-surcharges

Get Dealer Surcharges

POST /pen/get-rates

Get Rates

POST /mitek/auto-verify-license

Auto Verify License

POST /mitek/manual-license-review

Manual License Review

GET /mitek/poll

Retrieve Manual License Review Updates

GET /mitek/retrieve-manual-results/{retrieval_id}

Retrieve Manual License Review Result

GET /mitek/retrieve-results

Retrieve Manual License Review Result

POST /kbb/get-tradein-years

Years

POST /kbb/get-tradein-makes

Makes

POST /kbb/get-tradein-models

Models

POST /kbb/get-tradein-trims

Trims

POST /kbb/get-tradein-allOptions

Options

POST /kbb/get-tradein-vehicleValue

Vehicle Value

POST /kbb/get-tradein-decodevin

Decode VIN

POST /payment/stripe/webhooks

Handle Stripe webhooks

What's Deprecated

POST /payment/account

Create Payment Account

GET /payment/account/{account_id}

Get Payment Account

POST /payment/account-link

Create Payment Account Link

POST /payment/payment-intent

Create Stripe Payment Intent

POST /payment/refund-for-payment-intent

Create Refund For Payment Intent

POST /payment/charge

Create Payment Charge

POST /payment/refund

Create Payment Refund

POST /plaid/link-token

Create link token

POST /plaid/access-token

Exchange public token for an access token

POST /plaid/stripe-bank-token

Create Stripe bank account token

POST /plaid/get-account-balance

Retrieve real-time balance data

What's Changed

POST /stripe/subscription

Request:

Changed content type : application/json

New required properties:

• purchase_details

New optional properties:

• package_cost
• package_name
• product_name
• Added property purchase_details (array)
  • Items (object):
    • Property product_name (string)
    • Property package_name (string)
    • Property package_cost (integer)
  • Deleted property product_name (string)
  • Deleted property package_name (string)
  • Deleted property package_cost (string)

POST /email/send-welcome-letter-email

Request:

Changed content type : application/json

New required properties:

• details

New optional properties:

• api_key
• product_name
• Added property details (array)
  • Items (object):
    • Property api_key (string)
    • Property product_name (string)
  • Deleted property api_key (string)
  • Deleted property product_name (string)

POST /email/send-payment-invoice-email

Request:

Changed content type : application/json

New required properties:

• charge_id
• invoice_url
• purchase_details

New optional properties:

• package_cost
• package_name
• product_name
• Added property purchase_details (array)
• Added property invoice_url (string)
• Added property charge_id (string)
• Deleted property product_name (string)
• Deleted property package_name (string)
• Deleted property package_cost (integer)

POST /payment/account

GET /payment/account/{account_id}

POST /payment/account-link

POST /payment/payment-intent

POST /payment/refund-for-payment-intent

POST /payment/charge

POST /payment/refund

POST /plaid/link-token

POST /plaid/access-token

POST /plaid/stripe-bank-token

POST /plaid/get-account-balance

POST /email/send-feedback-email

Request:

Changed content type : application/json

• Added property rating (string)

• Added property follow_up (string)

POST /mitek/mitek-account

Request:

Changed content type : application/json

• Changed property mitek_account (object)

  • Deleted property mitek_identity_api_host (string)

    MiTek Identity API Host URL

  • Deleted property mitek_identity_token_url (string)

    MiTek Identity Token URL

  • Deleted property mitek_manual_api_host (string)

    MiTek Manual API Host URL

  • Deleted property mitek_manual_token_url (string)

    MiTek Manual Token URL

POST /payment/customers

Request:

Changed content type : application/json

• Added property address (object)

  Customer address

  • Property city (string)

    Customer city, district, suburb, town, or village.

  • Property country (string)

    Customer country Two-letter country code

  • Property line1 (string)

    Customer address line 1

  • Property line2 (string)

    Customer address line 2

  • Property postal_code (string)

    Customer zip or postal code

  • Property state (string)

    Customer state, county, province, or region

• Added property phone (string)

  Customer phone number

PATCH /payment/customers/{customer_id}

Request:

Changed content type : application/json

• Added property address (object)

  Customer address

• Added property phone (string)

  Customer phone number

PATCH /payment/promotion-codes/{promotion_id}

Request:

Changed content type : application/json

New optional properties:

• coupon

• Deleted property coupon (string)

  The coupon for this promotion code

• Deleted property code (string)

  The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.

• Deleted property customer (string)

  The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.

• Deleted property expires_at (string)

  The timestamp at which this promotion code will expire.

• Deleted property max_redemptions (integer)

  A positive integer specifying the number of times the promotion code can be redeemed.

• Changed property metadata (object)

  Set of key-value pairs that you can attach to an object.

GET /payment/prices

Parameters:

Changed: active in query

Only return prices that are active or inactive (e.g., pass false to list all inactive prices).

Changed: product in query

Only return prices for the given product.

Changed: type in query

Only return prices of type recurring or one_time.

Changed: limit in query

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

POST /payment/subscriptions

Request:

Changed content type : application/json

New optional properties:

• cancel_at_period_end
• currency
• default_payment_method
• metadata

• Added property description (string)

  The subscription’s description, meant to be displayable to the customer.

• Added property payment_behavior (string)

  Only applies to subscriptions with collection_method=charge_automatically.

• Added property add_invoice_items (array)

  A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription

  Items (object):

  • Property price (string)

    The ID of the price object.

  • Property price_data (object)

    Data used to generate a new Price object inline.

    • Property currency (string)

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • Property product (string)

      The ID of the product that this price will belong to.

    • Property recurring (object)

      The recurring components of a price such as interval and interval_count.

      • Property interval (string)

        Specifies billing frequency. Either day, week, month or year.

      • Property interval_count (string)

        The number of intervals between subscription billings

    • Property unit_amount_decimal (string)

      Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    • Property tax_behavior (string)

      Specifies whether the price is considered inclusive of taxes or exclusive of taxes

    • Property unit_amount (string)

      A positive integer in cents (or 0 for a free price) representing how much to charge.

  • Property quantity (integer)

    Quantity for this item. Defaults to 1.

  • Property tax_rates (string)

    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.

• Added property application_fee_percent (integer)

  A non-negative decimal between 0 and 100

• Added property automatic_tax (object)

  Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

  • Property enabled (boolean)

    Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.

• Added property backdate_start_date (string)

  For new subscriptions, a past timestamp to backdate the subscription’s start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time

• Added property billing_cycle_anchor (string)

  A future timestamp to anchor the subscription’s billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.

• Added property billing_thresholds (object)

  Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

  • Property amount_gte (string)

    Monetary threshold that triggers the subscription to advance to a new billing period

  • Property reset_billing_cycle_anchor (boolean)

    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.

• Added property cancel_at (string)

  A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior.

• Added property collection_method (string)

  Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice

• Added property coupon (string)

  The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

• Added property days_until_due (string)

  Number of days a customer has to pay invoices generated by this subscription

• Added property default_source (string)

  ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state

• Added property default_tax_rates (string)

  The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

• Added property off_session (string)

  Indicates if a customer is on or off-session while an invoice payment is attempted.

• Added property on_behalf_of (string)

  The account on behalf of which to charge, for each of the subscription’s invoices.

• Added property pending_invoice_item_interval (object)

  Specifies an interval for how often to bill for any pending invoice items.

  • Property interval (string)

    Specifies invoicing frequency. Either day, week, month or year.

  • Property interval_count (string)

    The number of intervals between invoices

• Added property promotion_code (string)

  A promotion code applied to a subscription will only affect invoices created for that particular subscription.

• Added property proration_behavior (string)

  Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.

• Added property transfer_data (object)

  If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

  • Property destination (string)

    ID of an existing, connected Stripe account.

  • Property amount_percent (string)

    A non-negative decimal between 0 and 100

• Added property trial_end (string)

  Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to.

• Added property trial_from_plan (string)

  Indicates if a plan’s trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false

• Added property trial_period_days (string)

  Integer representing the number of trial period days before the customer is charged for the first time.

• Added property payment_settings (object)

  Payment settings to pass to invoices created by the subscription.

  • Property payment_method_options (object)

    Payment-method-specific configuration to provide to invoices created by the subscription.

  • Property payment_method_types (array)

    The list of payment method types

    Items (string):

  • Property save_default_payment_method (string)

    Either off, or on_subscription. With on_subscription Stripe updates subscription.default_payment_method when a subscription payment succeeds.

• Changed property items (object -> array)

  Subscription items List

PATCH /payment/subscriptions/{subscription_id}

Request:

Changed content type : application/json

New optional properties:

• cancel_at_period_end
• currency
• default_payment_method
• items
• metadata

• Added property description (string)

  The subscription’s description, meant to be displayable to the customer.

• Added property payment_behavior (string)

  Only applies to subscriptions with collection_method=charge_automatically.

• Added property add_invoice_items (array)

  A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription

• Added property application_fee_percent (integer)

  A non-negative decimal between 0 and 100

• Added property automatic_tax (object)

  Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

• Added property billing_cycle_anchor (string)

  A future timestamp to anchor the subscription’s billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.

• Added property billing_thresholds (object)

  Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

• Added property cancel_at (string)

  A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior.

• Added property collection_method (string)

  Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice

• Added property coupon (string)

  The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

• Added property days_until_due (string)

  Number of days a customer has to pay invoices generated by this subscription

• Added property default_source (string)

  ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state

• Added property default_tax_rates (string)

  The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

• Added property off_session (string)

  Indicates if a customer is on or off-session while an invoice payment is attempted.

• Added property on_behalf_of (string)

  The account on behalf of which to charge, for each of the subscription’s invoices.

• Added property pause_collection (object)

  If specified, payment collection for this subscription will be paused.

  • Property behavior (string)

    The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.

  • Property resumes_at (string)

    The time after which the subscription will resume collecting payments.

• Added property pending_invoice_item_interval (object)

  Specifies an interval for how often to bill for any pending invoice items.

• Added property promotion_code (string)

  A promotion code applied to a subscription will only affect invoices created for that particular subscription.

• Added property proration_behavior (string)

  Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.

• Added property transfer_data (object)

  If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

• Added property trial_end (string)

  Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to.

• Added property trial_from_plan (string)

  Indicates if a plan’s trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false

• Added property payment_settings (object)

  Payment settings to pass to invoices created by the subscription.

• Deleted property currency (string)

  Three-letter ISO currency code, in lowercase. Must be a supported currency

• Changed property items (object -> array)

  Subscription items List

POST /payment/invoices

Request:

Changed content type : application/json

• Added property account_tax_ids (string)

  The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

• Added property application_fee_amount (integer)

  A fee in cents that will be applied to the invoice and transferred to the application owner’s account.

• Added property automatic_tax (object)

  Settings for automatic tax lookup for this invoice.

• Added property currency (string)

  The currency to create this invoice in. Defaults to that of customer if not specified.

• Added property custom_fields (array)

  A list of up to 4 custom fields to be displayed on the invoice

  Items (object):

  • Property name (string)

    Name of the custom field

  • Property value (string)

    Value of the custom field that will be shown in invoice

• Added property days_until_due (string)

  The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.

• Added property default_payment_method (string)

  ID of the default payment method for the invoice. It must belong to the customer associated with the invoice.

• Added property default_source (string)

  ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state.

• Added property default_tax_rates (array)

  The tax rates that will apply to any line item that does not have tax_rates set.

  Items (string):

• Added property discounts (array)

  The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.

  Items (object):

• Added property due_date (string)

  The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.

• Added property footer (string)

  Footer to be displayed on the invoice.

• Added property from_invoice (object)

  Revise an existing invoice. The new invoice will be created in status=draft.

  • Property action (string)

    The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted

  • Property invoice (string)

    The id of the invoice that will be cloned.

• Added property on_behalf_of (string)

  The account (if any) for which the funds of the invoice payment are intended.

• Added property payment_settings (object)

  Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

• Added property pending_invoice_items_behavior (string)

  How to handle pending invoice items on invoice creation. One of include or exclude

• Added property rendering_options (object)

  Options for invoice PDF rendering

• Added property shipping_cost (object)

  Settings for the cost of shipping for this invoice.

• Added property shipping_details (object)

  Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer

• Added property statement_descriptor (object)

  Extra information about a charge for the customer's credit card statement. It must contain at least one letter.

• Added property transfer_data (object)

  If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge

PATCH /payment/invoices/{invoice_id}

Request:

Changed content type : application/json

• Added property account_tax_ids (string)

  The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

• Added property application_fee_amount (string)

  A fee in cents that will be applied to the invoice and transferred to the application owner’s account.

• Added property automatic_tax (object)

  Settings for automatic tax lookup for this invoice.

• Added property custom_fields (array)

  A list of up to 4 custom fields to be displayed on the invoice

• Added property days_until_due (string)

  The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.

• Added property default_payment_method (string)

  ID of the default payment method for the invoice. It must belong to the customer associated with the invoice.

• Added property default_source (string)

  ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state.

• Added property default_tax_rates (array)

  The tax rates that will apply to any line item that does not have tax_rates set.

• Added property discounts (array)

  The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.

• Added property due_date (string)

  The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.

• Added property footer (string)

  Footer to be displayed on the invoice.

• Added property on_behalf_of (string)

  The account (if any) for which the funds of the invoice payment are intended.

• Added property payment_settings (object)

  Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

• Added property rendering_options (object)

  Options for invoice PDF rendering

• Added property shipping_cost (object)

  Settings for the cost of shipping for this invoice.

• Added property shipping_details (object)

  Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer

• Added property statement_descriptor (object)

  Extra information about a charge for the customer's credit card statement. It must contain at least one letter.

• Added property transfer_data (object)

  If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge

• Deleted property subscription (string)

  The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription

GET /payment/credit-notes

Parameters:

Changed: ending_before in query

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Changed: limit in query

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Changed: starting_after in query

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Changed: invoice in query

Only return credit notes for the invoice specified by this invoice ID.

Changed: customer in query

Only return credit notes for the customer specified by this customer ID.

PATCH /payment/credit-notes/{credit_note_id}

Request:

Changed content type : application/json

• Changed property metadata (object)

GET /payment/credit-notes/{credit_note_id}/lines

Parameters:

Changed: ending_before in query

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Changed: limit in query

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Changed: starting_after in query

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

POST /payment/credit-notes/preview/lines

Parameters:

Changed: ending_before in query

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Changed: limit in query

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Changed: starting_after in query

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

POST /socure/email-auth-score

Request:

Changed content type : application/json

New required properties:

• country

• Added property country (string)

  2 characters(e.g 'us') - The country where the consumer resides, specified in ISO 3166-1 alpha-2 format.

POST /mitek/verify-license

Return Type:

Changed response : 201 Created

Successful

• Changed content type : application/json

  • Changed property mitek_response (object)

    MiTek complete response.

    • Changed property evidence (array)

      Changed items (object):

      • Changed property images (array)

        Changed items (object):

        • Changed property derivedImages (object)

          New optional properties:

          • croppedDocument
          • croppedPortrait