Create a Season Set
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ] }, \"metadata\": { \"Season Program\" : \"End of the Year Program\" } }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets"
payload = "{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ] }, \"metadata\": { \"Season Program\" : \"End of the Year Program\" } }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "object": "SeasonSet", "id": "seasonset_1", "seasons": { "object": "List", "data": [ { "object": "Season", "description": "Yearly season subscription", "starts": "2022-12-31T00:00:00+00:00", "ends": "2023-01-06T00:00:00+00:00" }, { "object": "Season", "description": "Yearly season subscription", "starts": "2023-12-31T00:00:00+00:00", "ends": "2024-01-06T00:00:00+00:00" } ] }, "metadata": { "Season Program" : "End of the Year Program" } }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('{ "object": "SeasonSet", "id": "seasonset_1", "seasons": { "object": "List", "data": [ { "object": "Season", "description": "Yearly season subscription", "starts": "2022-12-31T00:00:00+00:00", "ends": "2023-01-06T00:00:00+00:00" }, { "object": "Season", "description": "Yearly season subscription", "starts": "2023-12-31T00:00:00+00:00", "ends": "2024-01-06T00:00:00+00:00" } ] }, "metadata": { "Season Program" : "End of the Year Program" } }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets"
payload := strings.NewReader("\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"vid\": \"416cb3f838cb43cc27dc7cfad8d0970ac6fba6e2\", \"created\": \"2022-09-01T09:04:41+00:00\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ], \"total_count\": 2 }, \"metadata\": { \"Season Program\": \"End of the Year Program\" } }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Create a Season Set
Creates a new Season Set Object.
POST
/
season_sets
Create a Season Set
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ] }, \"metadata\": { \"Season Program\" : \"End of the Year Program\" } }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets"
payload = "{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ] }, \"metadata\": { \"Season Program\" : \"End of the Year Program\" } }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "object": "SeasonSet", "id": "seasonset_1", "seasons": { "object": "List", "data": [ { "object": "Season", "description": "Yearly season subscription", "starts": "2022-12-31T00:00:00+00:00", "ends": "2023-01-06T00:00:00+00:00" }, { "object": "Season", "description": "Yearly season subscription", "starts": "2023-12-31T00:00:00+00:00", "ends": "2024-01-06T00:00:00+00:00" } ] }, "metadata": { "Season Program" : "End of the Year Program" } }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('{ "object": "SeasonSet", "id": "seasonset_1", "seasons": { "object": "List", "data": [ { "object": "Season", "description": "Yearly season subscription", "starts": "2022-12-31T00:00:00+00:00", "ends": "2023-01-06T00:00:00+00:00" }, { "object": "Season", "description": "Yearly season subscription", "starts": "2023-12-31T00:00:00+00:00", "ends": "2024-01-06T00:00:00+00:00" } ] }, "metadata": { "Season Program" : "End of the Year Program" } }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets"
payload := strings.NewReader("\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/season_sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"object\\\": \\\"SeasonSet\\\", \\\"id\\\": \\\"seasonset_1\\\", \\\"seasons\\\": { \\\"object\\\": \\\"List\\\", \\\"data\\\": [ { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2022-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2023-01-06T00:00:00+00:00\\\" }, { \\\"object\\\": \\\"Season\\\", \\\"description\\\": \\\"Yearly season subscription\\\", \\\"starts\\\": \\\"2023-12-31T00:00:00+00:00\\\", \\\"ends\\\": \\\"2024-01-06T00:00:00+00:00\\\" } ] }, \\\"metadata\\\": { \\\"Season Program\\\" : \\\"End of the Year Program\\\" } }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"SeasonSet\", \"id\": \"seasonset_1\", \"vid\": \"416cb3f838cb43cc27dc7cfad8d0970ac6fba6e2\", \"created\": \"2022-09-01T09:04:41+00:00\", \"seasons\": { \"object\": \"List\", \"data\": [ { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2022-12-31T00:00:00+00:00\", \"ends\": \"2023-01-06T00:00:00+00:00\" }, { \"object\": \"Season\", \"description\": \"Yearly season subscription\", \"starts\": \"2023-12-31T00:00:00+00:00\", \"ends\": \"2024-01-06T00:00:00+00:00\" } ], \"total_count\": 2 }, \"metadata\": { \"Season Program\": \"End of the Year Program\" } }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
JSON A full SeasonSet object.
The SeasonSet object defines an array of seasons, with an identifier.
Value is "SeasonSet"
Available options:
SeasonSet A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
Maximum string length:
128The date and time the plan was created.
An array of Seasons that make up the SeasonSet.
Show child attributes
Show child attributes
Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.
The metadata field supports key-value pairs with the following limitations:
Keys can be up to 256 characters
Keys can be any string that is needed, except only CashBox can prefix keys with vin:
Values can be up to 1024 characters
In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.
Response
JSON A full Season Set object.
The SeasonSet object defines an array of seasons, with an identifier.
Value is "SeasonSet"
Available options:
SeasonSet A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
Maximum string length:
128The date and time the plan was created.
An array of Seasons that make up the SeasonSet.
Show child attributes
Show child attributes
Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.
The metadata field supports key-value pairs with the following limitations:
Keys can be up to 256 characters
Keys can be any string that is needed, except only CashBox can prefix keys with vin:
Values can be up to 1024 characters
In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.