Skip to main content
GET
/
v1
/
customer
/
{customerId}
/
getSubscription
get subscription
curl --request GET \
  --url https://api.unprice.dev/v1/customer/{customerId}/getSubscription \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "projectId": "<string>",
  "createdAtM": 123,
  "updatedAtM": 123,
  "customerId": "<string>",
  "status": "idle",
  "active": true,
  "planSlug": "<string>",
  "timezone": "<string>",
  "locked": true,
  "lockedAt": 123,
  "currentCycleStartAt": 123,
  "currentCycleEndAt": 123,
  "previousCycleStartAt": 123,
  "previousCycleEndAt": 123,
  "invoiceAt": 123,
  "renewAt": 123,
  "endAt": 123,
  "lastRenewAt": 123,
  "lastInvoiceAt": 123,
  "metadata": {
    "reason": "payment_failed",
    "note": "<string>",
    "dates": {
      "lastChangeAt": 123,
      "cancelAt": 123
    }
  },
  "project": {
    "enabled": true
  },
  "customer": {
    "active": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

The customer ID

Example:

"cus_1H7KQFLr7RepUyQBKdnvY"

Response

The result of the get subscription

id
string
required
Maximum string length: 36
projectId
string
required
Maximum string length: 36
createdAtM
number
required
updatedAtM
number
required
customerId
string
required
Maximum string length: 36
status
enum<string>
required
Available options:
idle,
renewing,
changing,
canceling,
expiring,
invoicing,
invoiced,
ending_trial,
active,
trialing,
canceled,
expired,
past_due
active
boolean
required
planSlug
string
required
Minimum string length: 1
timezone
string
required
Minimum string length: 1
locked
boolean
required
lockedAt
number | null
required
currentCycleStartAt
number
required
currentCycleEndAt
number
required
previousCycleStartAt
number | null
required
previousCycleEndAt
number | null
required
invoiceAt
number
required
renewAt
number
required
endAt
number | null
required
lastRenewAt
number
required
lastInvoiceAt
number
required
metadata
object
required
project
object
required
customer
object
required