Skip to main content
GET
/
active-subscriptions
List active subscriptions
curl --request GET \
  --url https://api.lavapayments.com/v1/active-subscriptions \
  --header 'Authorization: Bearer <token>'
[
  {
    "active_subscription_id": "<string>",
    "wallet_id": "<string>",
    "subscription_config_id": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "billing_anchor": 123,
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "subscription_config": {
      "subscription_config_id": "<string>",
      "merchant_id": "<string>",
      "name": "<string>",
      "period_amount": "<string>",
      "rollover_type": "full",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "wallet": {
      "wallet_id": "<string>",
      "phone": "<string>",
      "active_balance": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "cancelled_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication used for standard API calls. Format: 'Bearer YOUR_API_KEY'

Response

List of active subscriptions

​
active_subscription_id
string
required

Unique identifier for the active subscription

​
wallet_id
string
required

Wallet ID of the subscriber

​
subscription_config_id
string
required

Unique identifier for the subscription configuration

​
started_at
string<date-time>
required

When the subscription started

​
billing_anchor
integer
required

Day of the month when billing occurs (1-31)

​
status
enum<string>
required

Status of the subscription

Available options:
active,
cancelled
​
created_at
string<date-time>
required

When the subscription was created

​
subscription_config
object
required
​
wallet
object
required
​
cancelled_at
string<date-time>

When the subscription was cancelled (if cancelled)