Get Billing Plan | Run Developers

import requests
url = "https://javelin.runpayments.io/api/v1/billing_plans/1"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": 2892,
  "name": "Testing Billing Plans",
  "description": null,
  "mid": "800000001780",
  "payment_account_uuid": "1f05e838-98de-6570-b2cc-3ba75e1fe147",
  "status": "ACTIVE",
  "rrule_pattern": "DTSTART:20251014T000000Z\nRRULE:FREQ=YEARLY;INTERVAL=1",
  "amount": "10.00",
  "scheduled_payments": [
    {
      "id": 2541405,
      "payment_number": 4,
      "payment_date": "2025-10-14T12:00:00.000Z",
      "amount_scheduled": 10,
      "amount_paid": 10,
      "amount_remaining": 0,
      "payment_status": "COMPLETED"
    },
    {
      "id": 2541408,
      "payment_number": 5,
      "payment_date": "2026-10-14T12:00:00.000Z",
      "amount_scheduled": 10,
      "amount_paid": 10,
      "amount_remaining": 0,
      "payment_status": "COMPLETED"
    },
    {
      "id": 2736363,
      "payment_number": 8,
      "payment_date": "2029-10-14T12:00:00.000Z",
      "amount_scheduled": 10,
      "amount_paid": 0,
      "amount_remaining": 10,
      "payment_status": "PENDING"
    }
  ]
}

Retrieve details of a billing plan including scheduled payments

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

Billing Plan ID

Response

Billing plan retrieved successfully

idinteger

Unique identifier for the billing plan

namestring

Name of the billing plan

descriptionstring or null

Detailed description of the billing plan

midstring

Merchant ID associated with the billing plan

payment_account_uuidstringformat: "uuid"

Reference to the vault payment method

statusenum

Current status of the billing plan

Allowed values:

rrule_patternstring

RFC 5545 recurrence rule defining payment frequency

amountstring

Recurring payment amount

scheduled_paymentslist of objects

List of scheduled payment instances

Authentication

Path parameters

Response

Errors