Skip to main content
GET
/
v0
/
subscriptions
/
{id}
Get
curl --request GET \
  --url https://api.paygentic.io/v0/subscriptions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "sub_j1k2l3m4n5o6p7q8",
  "object": "subscription",
  "autoCharge": true,
  "createdAt": "2024-02-01T14:45:30Z",
  "customerId": "cus_r9s0t1u2v3w4x5y6",
  "endingAt": "2024-12-31T23:59:59Z",
  "estimatedTaxRate": 10,
  "items": [
    {
      "billableMetricId": "bm_p3q4r5s6t7u8v9w0",
      "billableMetricName": "Storage Capacity",
      "quantity": 500,
      "totalCost": "75000000000000",
      "unitPrice": "150000000000"
    }
  ],
  "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"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Path Parameters

​
id
string
required

Response

Subscription details

​
id
string
​
object
enum<string>
Available options:
subscription
​
autoCharge
boolean
default:false

Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.

​
createdAt
string<date-time>
​
customerId
string
​
endingAt
string<date-time>
​
estimatedTaxRate
number

Projected tax percentage rate. Sample values: 8.875 indicates 8.875% tax rate, 10.0 indicates 10% tax rate, 0 indicates no tax applied

​
items
object[]

Array of upfront subscription items with quantities and costs

​
name
string
​
payment
object

Payment session details when upfront payment is required

​
planId
string
​
prefundAmount
string

Minimum required wallet balance in atomic units. Sample values: '200000000000' equals $200.00 minimum, '1000000000000' equals $1000.00 minimum

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

ID of who terminated the subscription (customer ID or merchant ID)

​
terminationReason
string

Reason for termination

​
testClockId
string

Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.

​
updatedAt
string<date-time>
​
walletId
string

Optional (virtual) wallet ID for the subscription