Skip to main content
GET
/
connections
/
{connection_id}
/
subscription
Get connection subscription
curl --request GET \
  --url https://api.lavapayments.com/v1/connections/{connection_id}/subscription \
  --header 'Authorization: Bearer <token>'
{
  "subscription": {
    "subscription_id": "<string>",
    "subscription_config_id": "<string>",
    "status": "active",
    "cycle_start_at": "2023-11-07T05:31:56Z",
    "cycle_end_at": "2023-11-07T05:31:56Z",
    "plan": {
      "name": "<string>",
      "period_amount": "<string>",
      "included_credit": "<string>",
      "billing_interval": "month",
      "rollover_type": "full",
      "bundle_rollover_type": "full"
    },
    "credits": {
      "total_remaining": "<string>",
      "cycle_remaining": "<string>",
      "bundle_remaining": "<string>"
    },
    "pending_change": {
      "type": "cancellation",
      "effective_at": "2023-11-07T05:31:56Z",
      "subscription_config_id": "<string>",
      "name": "<string>",
      "period_amount": "<string>",
      "included_credit": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

connection_id
string
required

Connection ID

Response

Connection subscription details

Subscription details for a connection

subscription
object
required

Subscription details, or null if no subscription