Skip to content

The subscription on Plan & usage

GET
/v1/billing/subscription
curl --request GET \
--url https://beta-api.plune.ai/v1/billing/subscription \
--cookie plune_session=<plune_session>

The latest payment subscription of the caller’s account, or of a company the caller owns (companyId), that was paid; a checkout not paid yet is not one. null when there is none. The session alone.

companyId
string

Team: a company the caller owns. Absent: the caller’s own account (Personal).

The subscription, or null

Media type application/json
object
subscription
required
One of:
object
id
required
string
provider
required
string
Allowed values: paddle monopay liqpay
tier
required
string
Allowed values: personal team
period
required
string
Allowed values: month year
seats
required
integer
>= 1
status
required
string
Allowed values: active cancelling ended
paidUntil
required
string | null format: date-time
nextPeriod
required

Another period, from the next one

string | null
Allowed values: month year
nextSeats
required

Fewer seats, from the next period

integer | null
>= 1
extraUsdCents
required

Seats added mid-period: owed on top of the next charge, in US cents (0 when nothing)

integer
cancelledAt
required

When the owner cancelled at the period’s end

string | null format: date-time
failedAt
required

The latest failed renewal payment not followed by a payment (Monopay: of an invoice still unpaid; Paddle: transaction.payment_failed)

string | null format: date-time
refund
required

A refund that ended it: Free limits at once

object
at
required
string format: date-time
payUrl
required

Monopay: the link to pay for the next period, while it lives

string | null format: uri
receiptUrl
required

Where the receipt is: Paddle’s customer portal page of the subscription (its past payments), for the owner; a short-lived link, never stored; null when the provider gives none

string | null format: uri
manageUrl
required

Where the card is changed: Paddle’s customer portal with the payment method form open, for the owner; a short-lived link, never stored; null when the provider gives none

string | null format: uri
Example
{
"subscription": {
"provider": "paddle",
"tier": "personal",
"period": "month",
"status": "active",
"nextPeriod": "month"
}
}

No / invalid session

An API token (session_required), or a member of the company who is not its owner (owner_only)

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

A company the caller is not in

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}