Subscriptions

List subscriptions

Retrieves a list of subscriptions.

GET
/biller/subscriptions

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

search?string

Response Body

application/json

curl -X GET "https://api.sandbox.billingrails.com/v1/biller/subscriptions"
{
  "subscriptions": [
    {
      "object": "subscription",
      "id": "sub_IhMUl3rrZ3",
      "status": "active",
      "account_id": "acc_IhMUl3rrZ3",
      "plan_id": "plan_IhMUl3rrZ3",
      "payment_method_id": "pme_IhMUl3rrZ3",
      "currency": "USD",
      "billing_cycle_type": "anniversary",
      "collection_method": "automatic",
      "current_period_start": "2025-02-14T17:33:40.843Z",
      "current_period_end": "2025-03-14T17:33:40.843Z",
      "first_billing_at": "2025-02-28T17:33:40.843Z",
      "previous_billing_at": "2025-02-14T17:33:40.843Z",
      "billed_through": "2025-03-14T17:33:40.843Z",
      "next_billing_at": "2025-03-14T17:33:40.843Z",
      "started_at": "2025-02-14T17:33:40.843Z",
      "trial_period_start": null,
      "trial_period_end": null,
      "created_at": "2025-02-14T17:33:40.843Z",
      "items": [
        {
          "plan_id": "plan_IhMUl3rrZ3",
          "quantity": 1
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_IhMUl3rrZ3",
    "current_page": 1,
    "per_page": 20,
    "total_count": 100
  }
}