Checkout a feature or subscription

Checkout a feature to buy it one time or start a subscription plan on a billing account.

Path Parameters

orgId string required
billingId string required

ID of the billing account to update the subscription for

application/json

Request Body required

successUrl string
cancelUrl string
subscriptionBody object
plan string
trailDays int32
featureBody object
feature string

Responses

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

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

checkoutSession object
id string
checkoutUrl string
successUrl string
cancelUrl string
state string
metadata object
createdAt date-time
updatedAt date-time
expireAt date-time

{
  "checkoutSession": {
    "id": "string",
    "checkoutUrl": "string",
    "successUrl": "string",
    "cancelUrl": "string",
    "state": "string",
    "metadata": {},
    "createdAt": "2024-01-01T17:13:19.584Z",
    "updatedAt": "2024-01-01T17:13:19.584Z",
    "expireAt": "2024-01-01T17:13:19.584Z"
  }
}

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...