Retrieve a subscription

GET

/v1/subscriptions/{subscriptionId}

• Production (nep_live_ keys)
• Local development

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

subscriptionId

required

string

Example

sub_01ARZ3NDEKTSV4RRFFQ69G5FAZ

Responses

200

A subscription object.

object

id

string

sub_01ARZ3NDEKTSV4RRFFQ69G5FAZ

customerId

string

priceId

string

status

string

Allowed values: trialing active past_due canceled

currentPeriodStart

string format: date-time

currentPeriodEnd

string format: date-time

cancelAtPeriodEnd

boolean

metadata

Up to 50 key/value string pairs you can attach to an object. Trile ignores them; they’re returned on every read.

object

key

additional properties

string

{
  "internal_user_id": "42"
}

404

Error.

object

success

boolean

error

object

code

string

insufficient_funds

message

string

Wallet balance is below the first cycle amount.

meta

object

requestId

string

req_aBcDeFgHiJkL