For Developers

Subscriptions Overview

A Subscription represents a recurring plan agreement (e.g. Edlink Starter, Pro, Enterprise) governing platform features and billing periods.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the subscription.
created_dateDateDate when the subscription was created.
updated_dateDateLast modification timestamp.
stateStringSubscription state: inactive, active, ended, paused, or canceled.
plan_idUUIDSubscribed plan.
start_dateDateWhen the subscription starts.
end_dateDateWhen the subscription ends, if it has an end date.
payment_termsStringPayment terms: net0, net15, net30, net90, or net180.
billing_team_idUUIDResponsible billing team.

JSON Example

{
    "id": "7fa194a2-1982-4f91-8841-59128aa10234",
    "state": "active",
    "plan_id": "18492019-4819-4bb4-8172-401928472910",
    "start_date": "2024-01-01T00:00:00.000Z",
    "payment_terms": "net30",
    "billing_team_id": "6a9e99a8-e165-4d0d-9b7d-6062a4be682d"
}