Querying for payment plans

Use the following endpoints to query for payment plans:

  • GET /admin/v1/payment-plans
  • GET /admin/v1/payment-plans/{paymentPlanId}
For example, the following is a snippet of the response for retrieving the sample data's "A Monthly 10% Down, 9 Max installments" payment plan (bc:1001):
GET /admin/v1/payment-plans/bc:1001

{
    "data": {
        "attributes": {
            "accountLevelBillingInvoiceItemPlacementCutoffType": {
                "code": "invoicebilldate",
                "name": "Bill Date"
            },
            "currencies": [
                {
                    "code": "usd",
                    "name": "USD"
                }
            ],
            "daysBeforePolicyExpirationForInvoicingBlackout": 30,
            "daysFromReferenceDateToDownPayment": -25,
            "daysFromReferenceDateToFirstInstallment": 0,
            "daysFromReferenceDateToOneTimeCharge": -25,
            "description": "Monthly 10% Down, 9 Max installments",
            "downPaymentAfter": {
                "code": "policyeffectivedate",
                "name": "Policy Effective Date"
            },
            "downPaymentPercent": "10.00",
            "downPaymentSecondInstallment": {
                "code": "downpayment",
                "name": "DownPayment"
            },
            "effectiveDate": "2022-07-28",
            "equityBuffer": 30,
            "equityWarningsEnabled": true,
            "firstInstallmentAfter": {
                "code": "policyeffectivedateplusoneperiod",
                "name": "One Interval After Policy Effective Date"
            },
            "id": "bc:SevjGb1S68cGb1SnUYcKo",
            "inUse": false,
            "installmentFeeDefaults": {},
            "invoicingBlackoutType": {
                "code": "billed",
                "name": "Billed"
            },
            "maximumNumberOfInstallments": 9,
            "name": "A Monthly 10% Down, 9 Max installments",
            "oneTimeChargeAfter": {
                "code": "policyeffectivedate",
                "name": "Policy Effective Date"
            },
            "periodicity": {
                "code": "monthly",
                "name": "Monthly"
            },
            "planOrder": 1,
            "policyLevelBillingBillDateOrDueDateBilling": {
                "code": "BillDateBilling",
                "name": "Bill Date"
            },
            "reporting": false,
            "skipFeeForDownPayment": true
            },

Additional filter options

Some GET endpoints that return collections have filter options that may not appear in the API definition for one reason or another. This documentation refers to them as additional filter options.

The GET /admin/v1/payment-plans endpoint has the following additional filter options:

  • currencies (It accepts a list of currency typecodes for use with the compareIn operator.)