API Reference

List all Offerings

get
https://api.vcita.biz/v3/license/offerings

Overview

List all Offerings in scope.

Available for Staff and Directory and Internal tokens.

Query Params
string
enum

Type of the offering. Possible values include: plan: For the main business subscription; app: For marketplace app subscriptions; addon: for SMS, staff_seats and other SKUs.

Allowed:
string

The underlying SKU, can be a code name of a package, a code name of an app or a code name of an addon like SMS or staff_seat. If not specified, all SKUs are returned

string

A specific directory mentioned by its unique identifier

string
enum

The payment type field defines the payment options available for an offering,external: Payment is not done by the platform (typically an API call from the partner), free: No payment is required; single_charge: A single, one-time payment is required to obtain the offering; monthly: A recurring payment made on a monthly basis; annual: A recurring payment made on a yearly basis; bundle: A subscription bundled with another subscription

Allowed:
boolean

The Offering status

integer
Defaults to 1

Page number of the results

integer
≤ 100
Defaults to 25

How many items to return per page

string
Defaults to updated_at:desc

Sort by fields, e.g., "created_at:asc,updated_at:desc"

Response

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago