Skip to main content
GET
/
v0
/
subscriptions
List
curl --request GET \
  --url https://api.paygentic.io/v0/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "sub_z1a2b3c4d5e6f7g8",
      "object": "subscription",
      "autoCharge": false,
      "taxExempt": false,
      "createdAt": "2024-01-10T08:00:00Z",
      "customerId": "cus_q3r4s5t6u7v8w9x0",
      "endingAt": null,
      "estimatedTaxRate": 8.5,
      "name": "StartupXYZ - Image Generation Service",
      "payment": null,
      "planId": "plan_t9u0v1w2x3y4z5a6",
      "prefundAmount": "50000000000",
      "startedAt": "2024-01-10T08:00:00Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-01-10T08:00:00Z",
      "walletId": "acc_b7c8d9e0f1g2h3i4"
    },
    {
      "id": "sub_j1k2l3m4n5o6p7q8",
      "object": "subscription",
      "autoCharge": true,
      "taxExempt": true,
      "createdAt": "2024-02-01T14:45:30Z",
      "customerId": "cus_r9s0t1u2v3w4x5y6",
      "endingAt": "2024-12-31T23:59:59Z",
      "estimatedTaxRate": 0,
      "name": "Analytics Co - Data Platform Enterprise",
      "payment": null,
      "planId": "plan_z7a8b9c0d1e2f3g4",
      "prefundAmount": "1000000000000",
      "startedAt": "2024-02-01T14:45:30Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-02-15T09:20:00Z",
      "walletId": "acc_h5i6j7k8l9m0n1o2"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
consumerId
string

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
​
customerId
string

Unique identifier for a customer

Pattern: ^cus_[a-zA-Z0-9]+$
​
limit
string
default:10

Number of subscriptions to return

​
merchantId
string

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
​
offset
string
default:0

Number of subscriptions to skip

​
status
enum<string>
Available options:
active,
terminated,
pending_payment
​
startedBefore
string<date-time>

Filter subscriptions started at or before this ISO 8601 date-time

​
include
enum<string>

Include related resources. When 'customer' is specified, each subscription includes merchant and consumer details.

Available options:
customer

Response

List of subscriptions

​
data
object[]
​
pagination
object

Offset-based pagination response.