Subscriptions
Get Subscriptions
Getting Started
- Overview
- Authentication
- Concepts
- Error Codes
- Real-time Events
- Changelog
Core Profile
- Profile
- Members
- Owners
- Addresses
- Documents
- Access Tokens
- Webhooks
Core Wallet
- Wallets
- Balances
- Accounts
- Contacts
- Payment Links
- Statements
- Transfers
- Transactions
Billing & Payments
- Customers
- Plans
- Vouchers
- Invoices
- Subscriptions
- Payments
Integrations
- Payment Providers
Analytics & Logs
- Metrics
- Logs
Resources
- Banks
- Countries
- Currencies
- Events
- Industries
- Legal Form
- Providers
- Scopes
Get Subscriptions
Fetch a list of subscriptions. (Business Only)
GET
/
subscriptions
curl --request GET \
--url https://api.live.paisr.tech/{version}/subscriptions \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"subscriptions": [
{
"id": "sub_123456",
"customer": {
"id": "cus_123456",
"name": "Jane Smith",
"email": "jane@example.com",
"billing_details": null,
"shipping_details": null
},
"payment_method": {
"id": "pmt_123456",
"type": "wallet",
"provider": "Paisr Pay"
},
"status": "active",
"currency": "SRD",
"auto_renew": true,
"trial_start": "2023-11-07T05:31:56Z",
"trial_end": "2023-11-07T05:31:56Z",
"billing_interval": 30,
"billing_start": "2023-11-07T05:31:56Z",
"billing_end": "2023-11-07T05:31:56Z",
"last_renew_at": "2023-11-07T05:31:56Z",
"next_renew_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The ID of the resource you want to filter based on. (e.g. Customer or Payment method ID's)
The currency you want to filter based on.
Available options:
pending
, expired
, trial
, active
, requires-action
, cancelled
Example:
"active"
Response
200
application/json
Successfully retrieved the list of subscriptions.
Example:
true
Example:
"sub_123456"
Example:
"cus_123456"
Example:
"Jane Smith"
Example:
"jane@example.com"
Example:
"Example Street 10"
Example:
"Paramaribo"
Example:
"SR"
Example:
"Example Street 11"
Example:
"Kwatta"
Example:
"Jane Smith"
Example:
"Example Street 10"
Example:
"Paramaribo"
Example:
"SR"
Example:
"+597-8123456"
Example:
"Example Street 11"
Example:
"Kwatta"
Available options:
pending
, expired
, trial
, active
, requires-action
, cancelled
Example:
"active"
Example:
"SRD"
Example:
true
Example:
30
Was this page helpful?
curl --request GET \
--url https://api.live.paisr.tech/{version}/subscriptions \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"subscriptions": [
{
"id": "sub_123456",
"customer": {
"id": "cus_123456",
"name": "Jane Smith",
"email": "jane@example.com",
"billing_details": null,
"shipping_details": null
},
"payment_method": {
"id": "pmt_123456",
"type": "wallet",
"provider": "Paisr Pay"
},
"status": "active",
"currency": "SRD",
"auto_renew": true,
"trial_start": "2023-11-07T05:31:56Z",
"trial_end": "2023-11-07T05:31:56Z",
"billing_interval": 30,
"billing_start": "2023-11-07T05:31:56Z",
"billing_end": "2023-11-07T05:31:56Z",
"last_renew_at": "2023-11-07T05:31:56Z",
"next_renew_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}
}