Skip to main content
GET
Get billing subscription

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Billing subscription sid (bl_sb_...).

Required string length: 18
Pattern: ^bl_sb_

Query Parameters

include[]
string[]

lines, price, product, latest_transactions; team is accepted and always null here.

Response

get success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
get
item
object
required
included
object
required
includes
string[]
required
meta
object
required