GET
/
subscriptions
/
{id}
Get a subscription
curl --request GET \
  --url https://api.paygentic.io/v0/subscriptions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "subscription",
  "customerId": "<string>",
  "planId": "<string>",
  "walletId": "<string>",
  "name": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endingAt": "2023-11-07T05:31:56Z",
  "terminatedAt": "2023-11-07T05:31:56Z",
  "terminatedBy": "<string>",
  "terminationReason": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Response

Subscription details

id
string
object
enum<string>
Available options:
subscription
customerId
string
planId
string
walletId
string

Optional (virtual) wallet ID for the subscription

name
string
status
enum<string>
Available options:
active,
terminated
createdAt
string<date-time>
updatedAt
string<date-time>
startedAt
string<date-time>
endingAt
string<date-time>
terminatedAt
string<date-time>
terminatedBy
string

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

terminationReason
string

Reason for termination