Get subscription

Get a subscription by ID.

Path Parameters

orgId string required
billingId string required

ID of the billing account to get the subscription for

id string required

ID of the subscription to get

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

subscription object
id string
customerId string
providerId string
planId string
state string
trialDays int32
metadata object
createdAt date-time
updatedAt date-time
canceledAt date-time
endedAt date-time

{
  "subscription": {
    "id": "string",
    "customerId": "string",
    "providerId": "string",
    "planId": "string",
    "state": "string",
    "trialDays": 0,
    "metadata": {},
    "createdAt": "2023-12-02T14:57:50.789Z",
    "updatedAt": "2023-12-02T14:57:50.789Z",
    "canceledAt": "2023-12-02T14:57:50.789Z",
    "endedAt": "2023-12-02T14:57:50.789Z"
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...