Skip to main content
PATCH
Update a plan file
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

identifier
string
required

Plan identifier.

pk
string<uuid>
required

Plan file UUID.

Body

application/json

Update display fields of a plan file. The underlying file cannot be replaced.

name
string
Example:

"Plan Terms (v2).pdf"

ordering
integer
Example:

1

enabled
boolean
Example:

true

Response

Updated plan file.

id
string<uuid>
read-only
Example:

"bf9f0fe0-c9c0-436d-8811-e412d0365470"

name
string
Example:

"custom-pricinig.png"

ordering
integer
Example:

0

enabled
boolean
Example:

true

downloadUrl
string<uri>
read-only

URL clients can hit to download the file. Carries a signed token and expires 24 hours after it was generated; requesting a fresh copy of the plan/subscription issues a new link.

Example:

"https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/?token=Yjk5ZjBmZTAtYzljMC00MzZkLTg4MTEtZTQxMmQwMzY1NDcw%3A1v2Abc%3Ahash"