Querying for billing plans

Use the following endpoints to query for billing plans:

• GET /admin/v1/billing-plans
  • Retrieves all billing plans
• GET /admin/v1/billing-plans/{billingPlanId}
  • Retrieves the specified billing plan

For example, the following is a snippet of the response for retrieving the sample data's "Standard Mail" billing plan (bc:101):

GET /admin/v1/billing-plans/bc:101

{
    "data": {
        "attributes": {
            "aggregation": {
                "code": "charges",
                "name": "Invoice Items"
            },
            "allowModOfManDisb": true,
            "availableDisbAmtType": {
                "code": "unappliedminusauc",
                "name": "Unapplied minus under contract"
            },
            "changeDeadlineIntervalDayCount": 0,
            "createApprActForAutoDisb": true,
            "currencies": [
                {
                    "code": "usd",
                    "name": "USD"
                }
            ],
            "delayDisbursement": 2,
            "description": "Direct bill, postal invoicing",
            "disbursementOverDefaults": {
                "usd": "0.00"
            },
            "draftDayLogic": {
                "code": "exact",
                "name": "Exact Day"
            },
            "draftIntervalDayCount": 0,
            "effectiveDate": "2022-03-25",
            "id": "bc:SwmB2Rt3gPdpWN5d33gpk",
            "inUse": true,
            "invoiceFeeDefaults": {
                "usd": "0.00"
            },
            "leadTimeDayUnit": {
                "code": "calendar",
                "name": "Calendar Days"
            },
            "lowBalanceMethod": {
                "code": "carryforward",
                "name": "Carry Forward"
            },
            "lowBalanceThresholdDefaults": {
                "usd": "0.00"
            },
            "name": "Standard Mail",
            "nonResponsivePmntDueInterval": 21,
            "paymentDueDayLogic": {
                "code": "exact",
                "name": "Exact Day"
            },
            "paymentDueInterval": 21,
            "paymentReversalFeeDefaults": {
                "usd": "0.00"
            },
            "planOrder": 1,
            "requestIntervalDayCount": 0,
            "reviewDisbursementOverDefaults": {
                "usd": "1000.00"
            },
            "sendAutoDisbAwaitingApproval": false,
            "skipInstallmentFees": false,
            "statement": {
                "code": "directbill",
                "name": "Direct Bill"
            },
            "suppressLowBalInvoices": false,
            "westernMethod": false
        },

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/billing-plans endpoint has the following additional filter options:

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