Update an Offering

put

https://api.vcita.biz/v3/license/offerings/{uid}

Overview

Update an Offering. Available for Admin tokens only.

Replace-all `prices` semantics

The prices array represents the complete desired set of currencies for the offering. Any currency not present in the request will be removed from the offering, along with its pay-per-unit prices and bundles. To edit a single currency, send the full list of currencies you want to keep, including the unchanged ones. Omit prices entirely to leave the existing prices untouched. Sending an empty array is rejected with 400.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid

string

required

Body Params

display_name

string

The SKU's display name

prices

array of objects

Complete desired set of currencies for the offering. Any currency not present is removed (replace-all), along with its pay-per-unit prices and bundles. Omit the field to keep the existing prices unchanged. Sending an empty array is rejected with 400.

prices

trial_type

string

enum

Defaults to no_trial

Specifies how the trial option is managed. expire: trial is enabled and subscription will expire after trial_period days. no_trial: no trial period is offered.

Allowed:

trial_period

number

Number of days for the trial period. Required when trial_type is expire. If not specified or set to 0, it indicates no trial period is offered.

is_active

boolean

Defaults to true

Current status of the directory offering

reporting_tags

array of strings

A list of tags to be used for reporting purposes. Tags categorize offerings for analytics and billing reports.

reporting_tags

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update an Offering