Skip to content
BoxBilling

Get subscription detail

GET
/portal/subscriptions/{subscription_id}

Get a specific subscription for the authenticated customer.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
subscription_id
required
Subscription Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
token
required
Token
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PortalSubscriptionResponse

Subscription response enriched with plan details for portal display.

object
id
required
Id
string format: uuid
external_id
required
External Id
string
status
required
SubscriptionStatus
string
Allowed values: pending active paused canceled terminated
started_at
required
Any of:
string format: date-time
canceled_at
required
Any of:
string format: date-time
paused_at
required
Any of:
string format: date-time
downgraded_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
plan
required
PlanSummary

Summary of a plan for comparison.

object
id
required
Id
string format: uuid
name
required
Name
string
code
required
Code
string
interval
required
Interval
string
amount_cents
required
Amount Cents
integer
currency
required
Currency
string
pending_downgrade_plan
Any of:
PlanSummary

Summary of a plan for comparison.

object
id
required
Id
string format: uuid
name
required
Name
string
code
required
Code
string
interval
required
Interval
string
amount_cents
required
Amount Cents
integer
currency
required
Currency
string

401

Section titled “401 ”

Invalid or expired portal token

404

Section titled “404 ”

Subscription not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object