Skip to main content
GET
/
v1
/
billing
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.paybridgenp.com/v1/billing/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "sub_01j9x2k3m4n5p6q7r8s9t0u1v2",
      "livemode": true,
      "status": "active",
      "displayStatus": "draft",
      "startDate": "2023-11-07T05:31:56Z",
      "currentPeriodStart": "2023-11-07T05:31:56Z",
      "currentPeriodEnd": "2023-11-07T05:31:56Z",
      "nextInvoiceAt": "2023-11-07T05:31:56Z",
      "trialEndsAt": "2023-11-07T05:31:56Z",
      "cancelAtPeriodEnd": true,
      "cancelledAt": "2023-11-07T05:31:56Z",
      "cancelReason": "<string>",
      "cancelEffectiveAt": "2023-11-07T05:31:56Z",
      "pausedAt": "2023-11-07T05:31:56Z",
      "pauseReason": "<string>",
      "endedAt": "2023-11-07T05:31:56Z",
      "providerPreference": "esewa",
      "referenceId": "<string>",
      "customer": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "plan": {
        "id": "<string>",
        "name": "<string>",
        "amount": 123,
        "currency": "<string>",
        "intervalUnit": "<string>",
        "intervalCount": 123
      },
      "latestInvoice": {
        "status": "<string>",
        "dueAt": "2023-11-07T05:31:56Z",
        "paidAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.paybridgenp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your PayBridge API key. Obtain one from the dashboard under Settings → API Keys. Prefix: pk_sandbox_ for testing, pk_live_ for production.

Query Parameters

​
status
enum<string>

Filter by display status.

Available options:
draft,
trialing,
active,
paused,
past_due,
cancelled,
completed
​
customerId
string

Filter by customer ID.

​
planId
string

Filter by plan ID.

​
page
integer
default:1
​
limit
integer
default:50
Required range: x <= 100

Response

Subscriptions list.

​
data
object[]
​
total
integer
​
page
integer
​
limit
integer